From 4bbd7b62860cb43f5cdc496ce3ff5d31bda1d462 Mon Sep 17 00:00:00 2001 From: pulumi-bot Date: Wed, 26 Jun 2024 13:11:48 +0000 Subject: [PATCH] Regenerating based on aws-cloudformation-user-guide @ 19dc52cd3f2007d6d268b65b739ffb5ebf8c1e76 --- .../aws-apigateway-domainname.json | 115 +- .../aws-bedrock-agent.json | 1 - .../aws-cloudwatch-metricstream.json | 15 +- .../aws-codebuild-project.json | 13 + .../aws-connect-evaluationform.json | 132 +- .../aws-controltower-enabledcontrol.json | 9 +- .../aws-dms-replicationconfig.json | 2 +- .../aws-ecr-repositorycreationtemplate.json | 4 +- .../aws-ecs-taskdefinition.json | 1518 ++++++++--------- .../aws-eks-cluster.json | 370 ++-- .../aws-elasticbeanstalk-environment.json | 6 +- .../aws-emrserverless-application.json | 18 +- .../aws-guardduty-filter.json | 2 +- .../aws-guardduty-malwareprotectionplan.json | 17 +- .../aws-iot-authorizer.json | 3 +- .../aws-iot-cacertificate.json | 1 + .../aws-iot-certificateprovider.json | 3 +- .../aws-iot-domainconfiguration.json | 3 +- aws-cloudformation-schema/aws-iot-policy.json | 3 +- .../aws-iot-provisioningtemplate.json | 6 +- .../aws-iot-rolealias.json | 3 +- .../aws-kinesisanalyticsv2-application.json | 16 + .../aws-lambda-function.json | 2 +- .../aws-location-apikey.json | 4 +- .../aws-location-placeindex.json | 4 +- .../aws-location-routecalculator.json | 4 +- .../aws-location-tracker.json | 4 +- .../aws-networkfirewall-firewall.json | 2 +- .../aws-quicksight-dashboard.json | 24 +- .../aws-rds-dbcluster.json | 707 ++++---- .../aws-rds-dbinstance.json | 787 ++++----- .../aws-rds-globalcluster.json | 4 + .../aws-resiliencehub-app.json | 2 +- .../aws-rolesanywhere-profile.json | 7 + .../aws-route53-hostedzone.json | 2 +- .../aws-secretsmanager-secret.json | 2 +- .../aws-ses-configurationset.json | 3 +- ...-ses-configurationseteventdestination.json | 18 + .../aws-signer-profilepermission.json | 3 +- .../aws-signer-signingprofile.json | 12 +- ...ws-verifiedpermissions-identitysource.json | 119 ++ .../aws-workspaces-workspacespool.json | 152 ++ .../pulumi-gen-aws-native/supported-types.txt | 1 + .../pulumi-resource-aws-native/metadata.json | 466 ++++- .../pulumi-resource-aws-native/schema.json | 657 +++++-- reports/missedAutonaming.json | 61 +- 46 files changed, 3129 insertions(+), 2178 deletions(-) create mode 100644 aws-cloudformation-schema/aws-workspaces-workspacespool.json diff --git a/aws-cloudformation-schema/aws-apigateway-domainname.json b/aws-cloudformation-schema/aws-apigateway-domainname.json index 5443561b05..800efa0e2a 100644 --- a/aws-cloudformation-schema/aws-apigateway-domainname.json +++ b/aws-cloudformation-schema/aws-apigateway-domainname.json @@ -1,9 +1,50 @@ { + "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "tagProperty" : "/properties/Tags", + "cloudFormationSystemTags" : true + }, + "handlers" : { + "read" : { + "permissions" : [ "apigateway:*" ] + }, + "create" : { + "permissions" : [ "apigateway:*" ] + }, + "update" : { + "permissions" : [ "apigateway:*" ] + }, + "list" : { + "permissions" : [ "apigateway:*" ] + }, + "delete" : { + "permissions" : [ "apigateway:*" ] + } + }, "typeName" : "AWS::ApiGateway::DomainName", + "readOnlyProperties" : [ "/properties/RegionalHostedZoneId", "/properties/DistributionDomainName", "/properties/RegionalDomainName", "/properties/DistributionHostedZoneId" ], "description" : "Resource Type definition for AWS::ApiGateway::DomainName.", - "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", + "createOnlyProperties" : [ "/properties/DomainName" ], + "additionalProperties" : false, + "primaryIdentifier" : [ "/properties/DomainName" ], "definitions" : { + "MutualTlsAuthentication" : { + "additionalProperties" : false, + "type" : "object", + "properties" : { + "TruststoreVersion" : { + "type" : "string" + }, + "TruststoreUri" : { + "type" : "string" + } + } + }, "EndpointConfiguration" : { + "additionalProperties" : false, "type" : "object", "properties" : { "Types" : { @@ -12,66 +53,50 @@ "type" : "string" } } - }, - "additionalProperties" : false - }, - "MutualTlsAuthentication" : { - "type" : "object", - "properties" : { - "TruststoreUri" : { - "type" : "string" - }, - "TruststoreVersion" : { - "type" : "string" - } - }, - "additionalProperties" : false + } }, "Tag" : { + "additionalProperties" : false, "type" : "object", "properties" : { - "Key" : { + "Value" : { "type" : "string" }, - "Value" : { + "Key" : { "type" : "string" } - }, - "additionalProperties" : false + } } }, "properties" : { - "DomainName" : { - "type" : "string" + "MutualTlsAuthentication" : { + "$ref" : "#/definitions/MutualTlsAuthentication" }, - "DistributionDomainName" : { + "OwnershipVerificationCertificateArn" : { "type" : "string" }, - "DistributionHostedZoneId" : { + "RegionalHostedZoneId" : { "type" : "string" }, - "EndpointConfiguration" : { - "$ref" : "#/definitions/EndpointConfiguration" - }, - "MutualTlsAuthentication" : { - "$ref" : "#/definitions/MutualTlsAuthentication" - }, "RegionalDomainName" : { "type" : "string" }, - "RegionalHostedZoneId" : { + "DomainName" : { "type" : "string" }, - "CertificateArn" : { + "SecurityPolicy" : { "type" : "string" }, - "RegionalCertificateArn" : { + "DistributionHostedZoneId" : { "type" : "string" }, - "OwnershipVerificationCertificateArn" : { + "EndpointConfiguration" : { + "$ref" : "#/definitions/EndpointConfiguration" + }, + "DistributionDomainName" : { "type" : "string" }, - "SecurityPolicy" : { + "RegionalCertificateArn" : { "type" : "string" }, "Tags" : { @@ -79,27 +104,9 @@ "items" : { "$ref" : "#/definitions/Tag" } - } - }, - "additionalProperties" : false, - "primaryIdentifier" : [ "/properties/DomainName" ], - "createOnlyProperties" : [ "/properties/DomainName" ], - "readOnlyProperties" : [ "/properties/RegionalHostedZoneId", "/properties/DistributionDomainName", "/properties/RegionalDomainName", "/properties/DistributionHostedZoneId" ], - "handlers" : { - "create" : { - "permissions" : [ "apigateway:*" ] }, - "read" : { - "permissions" : [ "apigateway:*" ] - }, - "update" : { - "permissions" : [ "apigateway:*" ] - }, - "delete" : { - "permissions" : [ "apigateway:*" ] - }, - "list" : { - "permissions" : [ "apigateway:*" ] + "CertificateArn" : { + "type" : "string" } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-bedrock-agent.json b/aws-cloudformation-schema/aws-bedrock-agent.json index 5656225f0b..9c9a2481c0 100644 --- a/aws-cloudformation-schema/aws-bedrock-agent.json +++ b/aws-cloudformation-schema/aws-bedrock-agent.json @@ -474,7 +474,6 @@ "Instruction" : { "type" : "string", "minLength" : 40, - "maxLength" : 4000, "description" : "Instruction for the agent." }, "KnowledgeBases" : { diff --git a/aws-cloudformation-schema/aws-cloudwatch-metricstream.json b/aws-cloudformation-schema/aws-cloudwatch-metricstream.json index be1ec1d199..0fc04ff9b4 100644 --- a/aws-cloudformation-schema/aws-cloudwatch-metricstream.json +++ b/aws-cloudformation-schema/aws-cloudwatch-metricstream.json @@ -185,7 +185,7 @@ "Value" : { "description" : "String which you can use to describe or define the tag.", "type" : "string", - "minLength" : 1, + "minLength" : 0, "maxLength" : 256 } }, @@ -209,18 +209,11 @@ "permissions" : [ "cloudwatch:GetMetricStream" ] } }, - "required" : [ "FirehoseArn", "RoleArn", "OutputFormat" ], - "anyOf" : [ { + "allOf" : [ { "required" : [ "FirehoseArn", "RoleArn", "OutputFormat" ] }, { - "allOf" : [ { - "required" : [ "FirehoseArn", "RoleArn", "OutputFormat" ] - } ] - }, { - "oneOf" : [ { - "required" : [ "IncludeFilters" ] - }, { - "required" : [ "ExcludeFilters" ] + "oneOf" : [ { }, { + "required" : [ "IncludeFilters", "ExcludeFilters" ] } ] } ], "createOnlyProperties" : [ "/properties/Name" ], diff --git a/aws-cloudformation-schema/aws-codebuild-project.json b/aws-cloudformation-schema/aws-codebuild-project.json index d021bedc13..5a136655df 100644 --- a/aws-cloudformation-schema/aws-codebuild-project.json +++ b/aws-cloudformation-schema/aws-codebuild-project.json @@ -152,6 +152,16 @@ }, "required" : [ "Type" ] }, + "ScopeConfiguration" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "Name" : { + "type" : "string" + } + }, + "required" : [ "Name" ] + }, "RegistryCredential" : { "type" : "object", "additionalProperties" : false, @@ -430,6 +440,9 @@ }, "Webhook" : { "type" : "boolean" + }, + "ScopeConfiguration" : { + "$ref" : "#/definitions/ScopeConfiguration" } } }, diff --git a/aws-cloudformation-schema/aws-connect-evaluationform.json b/aws-cloudformation-schema/aws-connect-evaluationform.json index 99036ab2b3..d68b406035 100644 --- a/aws-cloudformation-schema/aws-connect-evaluationform.json +++ b/aws-cloudformation-schema/aws-connect-evaluationform.json @@ -1,6 +1,6 @@ { "typeName" : "AWS::Connect::EvaluationForm", - "description" : "Resource Type definition for AWS::Connect::EvaluationForm", + "description" : "Creates an evaluation form for the specified CON instance.", "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect", "definitions" : { "RefId" : { @@ -21,54 +21,54 @@ "maximum" : 10 }, "EvaluationFormBaseItem" : { - "description" : "The evaluation form base item.", + "description" : "An item at the root level. All items must be sections.", "type" : "object", "additionalProperties" : false, "properties" : { "Section" : { - "description" : "The evaluation form section item", + "description" : "A subsection or inner section of an item.", "$ref" : "#/definitions/EvaluationFormSection" } }, "required" : [ "Section" ] }, "EvaluationFormItem" : { - "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.", "type" : "object", "additionalProperties" : false, "properties" : { "Section" : { - "description" : "The evaluation form section item", + "description" : "The information of the section.", "$ref" : "#/definitions/EvaluationFormSection" }, "Question" : { - "description" : "The evaluation form question item", + "description" : "The information of the question.", "$ref" : "#/definitions/EvaluationFormQuestion" } } }, "EvaluationFormSection" : { - "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).", "type" : "object", "additionalProperties" : false, "properties" : { "Title" : { - "description" : "The title of the section.", + "description" : "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128.", "type" : "string", "minLength" : 1, "maxLength" : 128 }, "Instructions" : { - "description" : "The instructions for the section.", + "description" : "The instructions of the section.", "type" : "string", "maxLength" : 1024 }, "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.", "$ref" : "#/definitions/RefId" }, "Items" : { - "description" : "The list of section items.", + "description" : "The items of the section.\n *Minimum*: 1", "type" : "array", "insertionOrder" : true, "minItems" : 1, @@ -78,43 +78,43 @@ } }, "Weight" : { - "description" : "The item weight used for scoring.", + "description" : "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100", "$ref" : "#/definitions/Weight" } }, "required" : [ "RefId", "Title" ] }, "EvaluationFormNumericQuestionOption" : { - "description" : "The option ranges used for scoring in numeric questions.", + "description" : "Information about the option range used for scoring in numeric questions.", "type" : "object", "additionalProperties" : false, "properties" : { "MinValue" : { - "description" : "The minimum value of the option range.", + "description" : "The minimum answer value of the range option.", "type" : "integer" }, "MaxValue" : { - "description" : "The maximum value of the option range.", + "description" : "The maximum answer value of the range option.", "type" : "integer" }, "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", "$ref" : "#/definitions/Score" }, "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" } }, "required" : [ "MinValue", "MaxValue" ] }, "NumericQuestionPropertyValueAutomation" : { - "description" : "The automation property name of the question.", + "description" : "Information about the property value used in automation of a numeric questions.", "type" : "object", "additionalProperties" : false, "properties" : { "Label" : { - "description" : "The automation property label.", + "description" : "The property label of the automation.", "type" : "string", "enum" : [ "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME" ] } @@ -122,32 +122,32 @@ "required" : [ "Label" ] }, "EvaluationFormNumericQuestionAutomation" : { - "description" : "The automation properties for the numeric question.", + "description" : "Information about the automation configuration in numeric questions.", "type" : "object", "additionalProperties" : false, "properties" : { "PropertyValue" : { - "description" : "The automation property name of the question.", + "description" : "The property value of the automation.", "$ref" : "#/definitions/NumericQuestionPropertyValueAutomation" } }, "required" : [ "PropertyValue" ] }, "EvaluationFormNumericQuestionProperties" : { - "description" : "The properties of the numeric question.", + "description" : "Information about properties for a numeric question in an evaluation form.", "type" : "object", "additionalProperties" : false, "properties" : { "MinValue" : { - "description" : "The minimum value for answers of the question.", + "description" : "The minimum answer value.", "type" : "integer" }, "MaxValue" : { - "description" : "The maximum value for answers of the question.", + "description" : "The maximum answer value.", "type" : "integer" }, "Options" : { - "description" : "The list of option ranges used for scoring.", + "description" : "The scoring options of the numeric question.", "type" : "array", "insertionOrder" : true, "minItems" : 1, @@ -157,54 +157,54 @@ } }, "Automation" : { - "description" : "The automation properties for the numeric question.", + "description" : "The automation properties of the numeric question.", "$ref" : "#/definitions/EvaluationFormNumericQuestionAutomation" } }, "required" : [ "MinValue", "MaxValue" ] }, "EvaluationFormSingleSelectQuestionAutomationOption" : { - "description" : "The automation option for the single-select question.", + "description" : "The automation options of the single select question.", "type" : "object", "additionalProperties" : false, "properties" : { "RuleCategory" : { - "description" : "The automation option based on Rules categories.", + "description" : "The automation option based on a rule category for the single select question.", "$ref" : "#/definitions/SingleSelectQuestionRuleCategoryAutomation" } }, "required" : [ "RuleCategory" ] }, "SingleSelectQuestionRuleCategoryAutomation" : { - "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.", "type" : "object", "additionalProperties" : false, "properties" : { "Category" : { - "description" : "The category name as defined in Rules.", + "description" : "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50", "type" : "string", "minLength" : 1, "maxLength" : 50 }, "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", "type" : "string", "enum" : [ "PRESENT", "NOT_PRESENT" ] }, "OptionRefId" : { - "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.", "$ref" : "#/definitions/RefId" } }, "required" : [ "Category", "Condition", "OptionRefId" ] }, "EvaluationFormSingleSelectQuestionAutomation" : { - "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.", "type" : "object", "additionalProperties" : false, "properties" : { "Options" : { - "description" : "The answer options for the automation.", + "description" : "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20", "type" : "array", "insertionOrder" : true, "minItems" : 1, @@ -214,45 +214,45 @@ } }, "DefaultOptionRefId" : { - "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.", "$ref" : "#/definitions/RefId" } }, "required" : [ "Options" ] }, "EvaluationFormSingleSelectQuestionOption" : { - "description" : "The option for a question.", + "description" : "Information about the automation configuration in single select questions.", "type" : "object", "additionalProperties" : false, "properties" : { "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.", "$ref" : "#/definitions/RefId" }, "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.", "type" : "string", "minLength" : 1, "maxLength" : 128 }, "Score" : { - "description" : "The score of the option.", + "description" : "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10", "$ref" : "#/definitions/Score" }, "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" } }, "required" : [ "RefId", "Text" ] }, "EvaluationFormSingleSelectQuestionProperties" : { - "description" : "The properties of the single-select question.", + "description" : "Information about the options in single select questions.", "type" : "object", "additionalProperties" : false, "properties" : { "Options" : { - "description" : "The list of options for the question.", + "description" : "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256", "type" : "array", "insertionOrder" : true, "minItems" : 2, @@ -262,19 +262,19 @@ } }, "DisplayAs" : { - "description" : "The display mode of the single-select question.", + "description" : "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``", "type" : "string", "enum" : [ "DROPDOWN", "RADIO" ] }, "Automation" : { - "description" : "The automation properties for the single-select question.", + "description" : "The display mode of the single select question.", "$ref" : "#/definitions/EvaluationFormSingleSelectQuestionAutomation" } }, "required" : [ "Options" ] }, "EvaluationFormQuestionTypeProperties" : { - "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.", "type" : "object", "additionalProperties" : false, "properties" : { @@ -283,29 +283,29 @@ "$ref" : "#/definitions/EvaluationFormNumericQuestionProperties" }, "SingleSelect" : { - "description" : "The properties of the single-select question.", + "description" : "The properties of the numeric question.", "$ref" : "#/definitions/EvaluationFormSingleSelectQuestionProperties" } } }, "EvaluationFormQuestion" : { - "description" : "The evaluation form question.", + "description" : "Information about a question from an evaluation form.", "type" : "object", "additionalProperties" : false, "properties" : { "Title" : { - "description" : "The title of the question.", + "description" : "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350.", "type" : "string", "minLength" : 1, "maxLength" : 350 }, "Instructions" : { - "description" : "The instructions for the question.", + "description" : "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024.", "type" : "string", "maxLength" : 1024 }, "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.", "$ref" : "#/definitions/RefId" }, "NotApplicableEnabled" : { @@ -313,33 +313,33 @@ "type" : "boolean" }, "QuestionType" : { - "description" : "The type of the question.", + "description" : "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``", "type" : "string", "enum" : [ "NUMERIC", "SINGLESELECT", "TEXT" ] }, "QuestionTypeProperties" : { - "description" : "The properties of the question", + "description" : "The properties of the type of question. Text questions do not have to define question type properties.", "$ref" : "#/definitions/EvaluationFormQuestionTypeProperties" }, "Weight" : { - "description" : "The question weight used for scoring.", + "description" : "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100", "$ref" : "#/definitions/Weight" } }, "required" : [ "RefId", "Title", "QuestionType" ] }, "ScoringStrategy" : { - "description" : "The scoring strategy.", + "description" : "A scoring strategy of the evaluation form.", "type" : "object", "additionalProperties" : false, "properties" : { "Mode" : { - "description" : "The scoring mode.", + "description" : "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``", "type" : "string", "enum" : [ "QUESTION_ONLY", "SECTION_ONLY" ] }, "Status" : { - "description" : "The scoring status.", + "description" : "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``", "type" : "string", "enum" : [ "ENABLED", "DISABLED" ] } @@ -353,14 +353,14 @@ "properties" : { "Key" : { "type" : "string", - "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters 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 -", "pattern" : "^(?!aws:)[a-zA-Z+-=._:/]+$", "minLength" : 1, "maxLength" : 128 }, "Value" : { "type" : "string", - "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 } }, @@ -369,28 +369,28 @@ }, "properties" : { "Title" : { - "description" : "The title of the evaluation form.", + "description" : "A title of the evaluation form.", "type" : "string", "minLength" : 1, "maxLength" : 128 }, "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.", "type" : "string", "maxLength" : 1024 }, "EvaluationFormArn" : { - "description" : "The Amazon Resource Name (ARN) for the evaluation form.", + "description" : "", "type" : "string", "pattern" : "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/evaluation-form/[-a-zA-Z0-9]*$" }, "InstanceArn" : { - "description" : "The Amazon Resource Name (ARN) of the instance.", + "description" : "The identifier of the Amazon Connect instance.", "type" : "string", "pattern" : "^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$" }, "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", "type" : "array", "insertionOrder" : true, "minItems" : 1, @@ -400,17 +400,17 @@ } }, "ScoringStrategy" : { - "description" : "The scoring strategy.", + "description" : "A scoring strategy of the evaluation form.", "$ref" : "#/definitions/ScoringStrategy" }, "Status" : { - "description" : "The status of the evaluation form.", + "description" : "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``", "type" : "string", "default" : "DRAFT", "enum" : [ "DRAFT", "ACTIVE" ] }, "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\"} }.", "type" : "array", "maxItems" : 50, "uniqueItems" : true, diff --git a/aws-cloudformation-schema/aws-controltower-enabledcontrol.json b/aws-cloudformation-schema/aws-controltower-enabledcontrol.json index b6157a358e..f1cf3c719f 100644 --- a/aws-cloudformation-schema/aws-controltower-enabledcontrol.json +++ b/aws-cloudformation-schema/aws-controltower-enabledcontrol.json @@ -98,13 +98,16 @@ "required" : [ "TargetIdentifier", "ControlIdentifier" ], "handlers" : { "create" : { - "permissions" : [ "controltower:ListEnabledControls", "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:EnableControl", "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ] + "permissions" : [ "controltower:ListEnabledControls", "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:EnableControl", "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ], + "timeoutInMinutes" : 720 }, "update" : { - "permissions" : [ "controltower:ListEnabledControls", "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:UpdateEnabledControl", "controltower:UntagResource", "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ] + "permissions" : [ "controltower:ListEnabledControls", "controltower:GetEnabledControl", "controltower:GetControlOperation", "controltower:UpdateEnabledControl", "controltower:UntagResource", "controltower:TagResource", "organizations:UpdatePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ], + "timeoutInMinutes" : 720 }, "delete" : { - "permissions" : [ "controltower:GetControlOperation", "controltower:DisableControl", "organizations:UpdatePolicy", "organizations:DeletePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ] + "permissions" : [ "controltower:GetControlOperation", "controltower:DisableControl", "organizations:UpdatePolicy", "organizations:DeletePolicy", "organizations:CreatePolicy", "organizations:AttachPolicy", "organizations:DetachPolicy", "organizations:ListPoliciesForTarget", "organizations:ListTargetsForPolicy", "organizations:DescribePolicy" ], + "timeoutInMinutes" : 720 }, "read" : { "permissions" : [ "controltower:ListEnabledControls", "controltower:GetEnabledControl", "controltower:ListTagsForResource" ] diff --git a/aws-cloudformation-schema/aws-dms-replicationconfig.json b/aws-cloudformation-schema/aws-dms-replicationconfig.json index f0824245e3..54d3aa5995 100644 --- a/aws-cloudformation-schema/aws-dms-replicationconfig.json +++ b/aws-cloudformation-schema/aws-dms-replicationconfig.json @@ -115,7 +115,7 @@ } }, "createOnlyProperties" : [ "/properties/ResourceIdentifier" ], - "readOnlyProperties" : [ "/Properties/ReplicationConfigArn" ], + "readOnlyProperties" : [ "/properties/ReplicationConfigArn" ], "primaryIdentifier" : [ "/properties/ReplicationConfigArn" ], "additionalIdentifiers" : [ [ "/properties/ReplicationConfigIdentifier" ] ], "tagging" : { diff --git a/aws-cloudformation-schema/aws-ecr-repositorycreationtemplate.json b/aws-cloudformation-schema/aws-ecr-repositorycreationtemplate.json index 66b1a8a918..9640eb8b7d 100644 --- a/aws-cloudformation-schema/aws-ecr-repositorycreationtemplate.json +++ b/aws-cloudformation-schema/aws-ecr-repositorycreationtemplate.json @@ -120,13 +120,13 @@ "primaryIdentifier" : [ "/properties/Prefix" ], "handlers" : { "create" : { - "permissions" : [ "ecr:CreateRepositoryCreationTemplate", "ecr:PutLifecyclePolicy", "ecr:SetRepositoryPolicy" ] + "permissions" : [ "ecr:CreateRepositoryCreationTemplate", "ecr:PutLifecyclePolicy", "ecr:SetRepositoryPolicy", "ecr:CreateRepository", "iam:CreateServiceLinkedRole" ] }, "read" : { "permissions" : [ "ecr:DescribeRepositoryCreationTemplates" ] }, "update" : { - "permissions" : [ "ecr:DescribeRepositoryCreationTemplates", "ecr:UpdateRepositoryCreationTemplate", "ecr:PutLifecyclePolicy", "ecr:SetRepositoryPolicy" ] + "permissions" : [ "ecr:DescribeRepositoryCreationTemplates", "ecr:UpdateRepositoryCreationTemplate", "ecr:PutLifecyclePolicy", "ecr:SetRepositoryPolicy", "ecr:CreateRepository", "iam:CreateServiceLinkedRole" ] }, "delete" : { "permissions" : [ "ecr:DeleteRepositoryCreationTemplate" ] diff --git a/aws-cloudformation-schema/aws-ecs-taskdefinition.json b/aws-cloudformation-schema/aws-ecs-taskdefinition.json index 89a3a384c9..964333d80e 100644 --- a/aws-cloudformation-schema/aws-ecs-taskdefinition.json +++ b/aws-cloudformation-schema/aws-ecs-taskdefinition.json @@ -1,1051 +1,1051 @@ { + "sourceUrl" : "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html", + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "tagProperty" : "/properties/Tags", + "cloudFormationSystemTags" : true + }, + "propertyTransform" : { + "/properties/TaskRoleArn" : "TaskRoleArn $OR $split(TaskRoleArn, \"role/\")[-1]" + }, + "handlers" : { + "read" : { + "permissions" : [ "ecs:DescribeTaskDefinition" ] + }, + "create" : { + "permissions" : [ "ecs:RegisterTaskDefinition", "ecs:DescribeTaskDefinition", "ecs:TagResource", "iam:GetRole", "iam:PassRole" ] + }, + "update" : { + "permissions" : [ "ecs:TagResource", "ecs:UntagResource", "ecs:ListTagsForResource", "ecs:DescribeTaskDefinition", "iam:GetRole", "iam:PassRole" ] + }, + "list" : { + "permissions" : [ "ecs:ListTaskDefinitions", "ecs:DescribeTaskDefinition" ] + }, + "delete" : { + "permissions" : [ "ecs:DeregisterTaskDefinition", "ecs:DescribeTaskDefinition", "iam:GetRole", "iam:PassRole" ] + } + }, "typeName" : "AWS::ECS::TaskDefinition", + "readOnlyProperties" : [ "/properties/TaskDefinitionArn" ], "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.", - "sourceUrl" : "https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html", + "createOnlyProperties" : [ "/properties/Family", "/properties/ContainerDefinitions", "/properties/Cpu", "/properties/ExecutionRoleArn", "/properties/InferenceAccelerators", "/properties/Memory", "/properties/NetworkMode", "/properties/PlacementConstraints", "/properties/ProxyConfiguration", "/properties/RequiresCompatibilities", "/properties/RuntimePlatform", "/properties/TaskRoleArn", "/properties/Volumes", "/properties/PidMode", "/properties/IpcMode", "/properties/EphemeralStorage" ], + "additionalProperties" : false, + "primaryIdentifier" : [ "/properties/TaskDefinitionArn" ], "definitions" : { - "ContainerDefinition" : { - "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.", + "VolumeFrom" : { + "description" : "Details on a data volume from another container in the same task definition.", + "additionalProperties" : false, + "type" : "object", + "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" + } + } + }, + "ContainerDependency" : { + "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.", + "additionalProperties" : false, + "type" : "object", + "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" + } + } + }, + "HealthCheck" : { + "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.", + "additionalProperties" : false, "type" : "object", - "required" : [ "Name", "Image" ], "properties" : { "Command" : { - "type" : "array", + "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, + "type" : "array", "items" : { "type" : "string" - }, - "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" : "integer", - "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." + "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.", + "type" : "integer" }, - "CredentialSpecs" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "type" : "string" - }, - "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)." + "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" }, - "DependsOn" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "$ref" : "#/definitions/ContainerDependency" - }, - "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." + "Interval" : { + "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.", + "type" : "integer" }, - "DisableNetworking" : { - "type" : "boolean", - "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." + "StartPeriod" : { + "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" + } + } + }, + "HostEntry" : { + "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.", + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Hostname" : { + "description" : "The hostname to use in the ``/etc/hosts`` entry.", + "type" : "string" }, - "DnsSearchDomains" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "type" : "string" - }, - "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." + "IpAddress" : { + "description" : "The IP address to use in the ``/etc/hosts`` entry.", + "type" : "string" + } + } + }, + "ContainerDefinition" : { + "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.", + "additionalProperties" : false, + "type" : "object", + "required" : [ "Name", "Image" ], + "properties" : { + "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" }, - "DnsServers" : { - "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, + "type" : "array", "items" : { - "type" : "string" - }, - "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." + "$ref" : "#/definitions/Secret" + } }, - "DockerLabels" : { - "type" : "object", - "patternProperties" : { - ".{1,}" : { - "type" : "string" - } - }, - "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}}'``" + "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. 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" }, - "DockerSecurityOptions" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "type" : "string" - }, - "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\"" + "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" }, - "EntryPoint" : { - "type" : "array", - "insertionOrder" : true, - "items" : { - "type" : "string" - }, - "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)." + "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).", + "$ref" : "#/definitions/HealthCheck" }, - "Environment" : { - "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.", - "type" : "array", - "insertionOrder" : false, + "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" + }, + "VolumesFrom" : { "uniqueItems" : true, + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/KeyValuePair" + "$ref" : "#/definitions/VolumeFrom" } }, - "EnvironmentFiles" : { - "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*.", - "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" + }, + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/EnvironmentFile" + "type" : "string" } }, - "Essential" : { - "type" : "boolean", - "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" : "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/HostEntry" - }, - "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" : { - "$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", - "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)." + "type" : "string" + } }, - "Hostname" : { - "type" : "string", - "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." + "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" }, "Image" : { "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``).", "type" : "string" }, - "Links" : { - "type" : "array", - "insertionOrder" : false, - "uniqueItems" : true, - "items" : { - "type" : "string" - }, - "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" : { - "$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." + "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" }, "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*." + "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*.", + "$ref" : "#/definitions/LogConfiguration" }, - "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. 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" : { - "type" : "integer", - "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" : { + "ResourceRequirements" : { + "description" : "The type and amount of a resource to assign to a container. The only supported resource is a GPU.", + "insertionOrder" : false, "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceRequirement" + } + }, + "EnvironmentFiles" : { + "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, - "uniqueItems" : true, + "type" : "array", "items" : { - "$ref" : "#/definitions/MountPoint" - }, - "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." + "$ref" : "#/definitions/EnvironmentFile" + } }, "Name" : { "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" : "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.", - "type" : "array", + "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*.", + "$ref" : "#/definitions/FirelensConfiguration" + }, + "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, - "uniqueItems" : true, + "type" : "array", "items" : { - "$ref" : "#/definitions/PortMapping" + "type" : "string" } }, - "Privileged" : { - "type" : "boolean", - "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." - }, - "ReadonlyRootFilesystem" : { - "type" : "boolean", - "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." + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/SystemControl" + } }, - "RepositoryCredentials" : { - "$ref" : "#/definitions/RepositoryCredentials", - "description" : "The private repository authentication credentials to use." + "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" }, - "ResourceRequirements" : { - "type" : "array", + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/ResourceRequirement" - }, - "description" : "The type and amount of a resource to assign to a container. The only supported resource is a GPU." + "type" : "string" + } }, - "Secrets" : { - "type" : "array", + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/Secret" - }, - "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" : "integer", - "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" : "integer", - "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" : "string" + } }, "Ulimits" : { - "type" : "array", + "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, + "type" : "array", "items" : { "$ref" : "#/definitions/Ulimit" - }, - "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" : "string", - "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" : "array", - "insertionOrder" : false, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/VolumeFrom" - }, - "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)." + "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" }, "WorkingDirectory" : { - "type" : "string", - "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)." + "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" }, - "Interactive" : { - "type" : "boolean", - "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)." + "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" }, - "PseudoTerminal" : { - "type" : "boolean", - "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)." + "RepositoryCredentials" : { + "description" : "The private repository authentication credentials to use.", + "$ref" : "#/definitions/RepositoryCredentials" }, - "SystemControls" : { - "type" : "array", + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/SystemControl" - }, - "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." - } - }, - "additionalProperties" : false - }, - "SystemControl" : { - "type" : "object", - "properties" : { - "Namespace" : { - "type" : "string", - "description" : "The namespaced kernel parameter to set a ``value`` for." + "$ref" : "#/definitions/HostEntry" + } }, - "Value" : { - "type" : "string", - "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." - } - }, - "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." - }, - "ContainerDependency" : { - "type" : "object", - "properties" : { - "ContainerName" : { - "type" : "string", - "description" : "The name of a container." + "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" }, - "Condition" : { - "type" : "string", - "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." - } - }, - "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." - }, - "Device" : { - "type" : "object", - "properties" : { - "ContainerPath" : { - "type" : "string", - "description" : "The path inside the container at which to expose the host device." + "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.", + "$ref" : "#/definitions/LinuxParameters" }, - "HostPath" : { - "type" : "string", - "description" : "The path for the device on the host container instance." + "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" }, - "Permissions" : { - "type" : "array", - "insertionOrder" : false, + "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" + }, + "MountPoints" : { "uniqueItems" : true, + "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, + "type" : "array", "items" : { - "type" : "string" - }, - "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." - } - }, - "additionalProperties" : false, - "description" : "The ``Device`` property specifies an object representing a container instance host device." - }, - "DockerVolumeConfiguration" : { - "type" : "object", - "properties" : { - "Autoprovision" : { - "type" : "boolean", - "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" : "string", - "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/)." + "$ref" : "#/definitions/MountPoint" + } }, - "DriverOpts" : { - "type" : "object", - "patternProperties" : { - ".{1,}" : { - "type" : "string" - } - }, - "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/)." + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/ContainerDependency" + } }, - "Labels" : { - "type" : "object", + "DockerLabels" : { "patternProperties" : { ".{1,}" : { "type" : "string" } }, + "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}}'``", "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/)." + "type" : "object" }, - "Scope" : { - "type" : "string", - "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." - } - }, - "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." - }, - "AuthorizationConfig" : { - "type" : "object", - "properties" : { - "IAM" : { - "type" : "string", - "enum" : [ "ENABLED", "DISABLED" ], - "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*." - }, - "AccessPointId" : { - "type" : "string", - "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*." - } - }, - "additionalProperties" : false, - "description" : "The authorization configuration details for the Amazon EFS file system." - }, - "EFSVolumeConfiguration" : { - "type" : "object", - "required" : [ "FilesystemId" ], - "properties" : { - "FilesystemId" : { - "type" : "string", - "description" : "The Amazon EFS file system ID to use." - }, - "RootDirectory" : { - "type" : "string", - "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." + "PortMappings" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/PortMapping" + } }, - "TransitEncryption" : { - "type" : "string", - "enum" : [ "ENABLED", "DISABLED" ], - "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*." + "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, + "type" : "array", + "items" : { + "type" : "string" + } }, - "TransitEncryptionPort" : { - "type" : "integer", - "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*." + "Environment" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/KeyValuePair" + } }, - "AuthorizationConfig" : { - "$ref" : "#/definitions/AuthorizationConfig", - "description" : "The authorization configuration details for the Amazon EFS file system." + "Links" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "type" : "string" + } } - }, - "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*." + } }, - "EnvironmentFile" : { + "SystemControl" : { + "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.", + "additionalProperties" : false, "type" : "object", "properties" : { "Value" : { - "type" : "string", - "description" : "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file." + "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" }, - "Type" : { - "type" : "string", - "description" : "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``." + "Namespace" : { + "description" : "The namespaced kernel parameter to set a ``value`` for.", + "type" : "string" } - }, - "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." + } }, - "EphemeralStorage" : { - "type" : "object", - "properties" : { - "SizeInGiB" : { - "type" : "integer", - "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." - } - }, + "DockerVolumeConfiguration" : { + "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.", "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." - }, - "FSxAuthorizationConfig" : { "type" : "object", - "required" : [ "CredentialsParameter", "Domain" ], "properties" : { - "CredentialsParameter" : { - "type" : "string", - "description" : "" + "DriverOpts" : { + "patternProperties" : { + ".{1,}" : { + "type" : "string" + } + }, + "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/).", + "additionalProperties" : false, + "type" : "object" }, - "Domain" : { - "type" : "string", - "description" : "" - } - }, - "additionalProperties" : false, - "description" : "" - }, - "FSxWindowsFileServerVolumeConfiguration" : { - "type" : "object", - "required" : [ "FileSystemId", "RootDirectory" ], - "properties" : { - "FileSystemId" : { - "type" : "string", - "description" : "The Amazon FSx for Windows File Server file system ID to use." + "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" }, - "RootDirectory" : { - "type" : "string", - "description" : "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host." + "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" }, - "AuthorizationConfig" : { - "$ref" : "#/definitions/FSxAuthorizationConfig", - "description" : "The authorization configuration details for the Amazon FSx for Windows File Server file system." - } - }, - "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*." - }, - "FirelensConfiguration" : { - "type" : "object", - "properties" : { - "Type" : { - "type" : "string", - "description" : "The log router to use. The valid values are ``fluentd`` or ``fluentbit``." + "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" }, - "Options" : { - "type" : "object", + "Labels" : { "patternProperties" : { ".{1,}" : { "type" : "string" } }, + "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/).", "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" + "type" : "object" } - }, - "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*." + } }, - "HealthCheck" : { - "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.", + "LogConfiguration" : { + "description" : "The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.", + "additionalProperties" : false, "type" : "object", + "required" : [ "LogDriver" ], "properties" : { - "Command" : { - "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/).", + "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, "type" : "array", - "insertionOrder" : true, "items" : { - "type" : "string" + "$ref" : "#/definitions/Secret" } }, - "Interval" : { - "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.", - "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.", - "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 3.", - "type" : "integer" + "Options" : { + "patternProperties" : { + ".{1,}" : { + "type" : "string" + } + }, + "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}}'``", + "additionalProperties" : false, + "type" : "object" }, - "StartPeriod" : { - "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" + "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" } - }, - "additionalProperties" : false + } }, - "HostEntry" : { + "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*.", + "additionalProperties" : false, "type" : "object", "properties" : { - "Hostname" : { - "type" : "string", - "description" : "The hostname to use in the ``/etc/hosts`` entry." + "Options" : { + "patternProperties" : { + ".{1,}" : { + "type" : "string" + } + }, + "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", + "additionalProperties" : false, + "type" : "object" }, - "IpAddress" : { - "type" : "string", - "description" : "The IP address to use in the ``/etc/hosts`` entry." + "Type" : { + "description" : "The log router to use. The valid values are ``fluentd`` or ``fluentbit``.", + "type" : "string" } - }, - "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." + } }, - "HostVolumeProperties" : { - "type" : "object", - "properties" : { - "SourcePath" : { - "type" : "string", - "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." - } - }, + "RuntimePlatform" : { + "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*.", "additionalProperties" : false, - "description" : "The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume." - }, - "InferenceAccelerator" : { "type" : "object", "properties" : { - "DeviceName" : { - "type" : "string", - "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)." + "OperatingSystemFamily" : { + "description" : "The operating system.", + "type" : "string" }, - "DeviceType" : { - "type" : "string", - "description" : "The Elastic Inference accelerator type to use." + "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" } - }, - "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*." + } }, "KernelCapabilities" : { + "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.", + "additionalProperties" : false, "type" : "object", "properties" : { "Add" : { - "type" : "array", + "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, + "type" : "array", "items" : { "type" : "string" - }, - "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" : "array", + "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, + "type" : "array", "items" : { "type" : "string" - }, - "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\"``" + } } - }, - "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." + } }, - "KeyValuePair" : { - "type" : "object", - "properties" : { - "Name" : { - "type" : "string", - "description" : "The name of the key-value pair. For environment variables, this is the name of the environment variable." - }, - "Value" : { - "type" : "string", - "description" : "The value of the key-value pair. For environment variables, this is the value of the environment variable." - } - }, + "Tmpfs" : { + "description" : "The container path, mount options, and size of the tmpfs mount.", "additionalProperties" : false, - "description" : "A key-value pair object." - }, - "LinuxParameters" : { "type" : "object", + "required" : [ "Size" ], "properties" : { - "Capabilities" : { - "$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" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "$ref" : "#/definitions/Device" - }, - "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" : "boolean", - "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" : "integer", - "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" : "integer", - "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." + "Size" : { + "description" : "The maximum size (in MiB) of the tmpfs volume.", + "type" : "integer" }, - "Swappiness" : { - "type" : "integer", - "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." + "ContainerPath" : { + "description" : "The absolute file path where the tmpfs volume is to be mounted.", + "type" : "string" }, - "Tmpfs" : { - "type" : "array", + "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, + "type" : "array", "items" : { - "$ref" : "#/definitions/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." + "type" : "string" + } } - }, - "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)." + } }, - "LogConfiguration" : { + "AuthorizationConfig" : { + "description" : "The authorization configuration details for the Amazon EFS file system.", + "additionalProperties" : false, "type" : "object", - "required" : [ "LogDriver" ], "properties" : { - "LogDriver" : { + "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*.", "type" : "string", - "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" : "object", - "patternProperties" : { - ".{1,}" : { - "type" : "string" - } - }, - "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}}'``" + "enum" : [ "ENABLED", "DISABLED" ] }, - "SecretOptions" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "$ref" : "#/definitions/Secret" - }, - "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*." + "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" } - }, - "additionalProperties" : false, - "description" : "The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container." + } }, "PortMapping" : { + "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.", + "additionalProperties" : false, "type" : "object", "properties" : { - "Name" : { + "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*.", "type" : "string", - "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*." - }, - "ContainerPort" : { - "type" : "integer", - "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." + "enum" : [ "http", "http2", "grpc" ] }, "ContainerPortRange" : { - "type" : "string", - "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." + "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" : { - "type" : "integer", - "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." + "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" + }, + "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" }, "Protocol" : { - "type" : "string", - "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." + "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" }, - "AppProtocol" : { - "type" : "string", - "enum" : [ "http", "http2", "grpc" ], - "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*." + "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" } - }, - "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." + } }, - "MountPoint" : { + "TaskDefinitionPlacementConstraint" : { + "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.", + "additionalProperties" : false, "type" : "object", + "required" : [ "Type" ], "properties" : { - "ContainerPath" : { - "type" : "string", - "description" : "The path on the container to mount the host volume at." - }, - "ReadOnly" : { - "type" : "boolean", - "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" : { + "description" : "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates.", + "type" : "string" }, - "SourceVolume" : { - "type" : "string", - "description" : "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``." + "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" } - }, + } + }, + "FSxAuthorizationConfig" : { + "description" : "", "additionalProperties" : false, - "description" : "The details for a volume mount point that's used in a container definition." + "type" : "object", + "required" : [ "CredentialsParameter", "Domain" ], + "properties" : { + "CredentialsParameter" : { + "description" : "", + "type" : "string" + }, + "Domain" : { + "description" : "", + "type" : "string" + } + } }, - "ProxyConfiguration" : { + "EFSVolumeConfiguration" : { + "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*.", + "additionalProperties" : false, "type" : "object", - "required" : [ "ContainerName" ], + "required" : [ "FilesystemId" ], "properties" : { - "ContainerName" : { + "FilesystemId" : { + "description" : "The Amazon EFS file system ID to use.", + "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*.", "type" : "string", - "description" : "The name of the container that will serve as the App Mesh proxy." + "enum" : [ "ENABLED", "DISABLED" ] }, - "ProxyConfigurationProperties" : { - "type" : "array", - "insertionOrder" : false, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/KeyValuePair" - }, - "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." + "AuthorizationConfig" : { + "description" : "The authorization configuration details for the Amazon EFS file system.", + "$ref" : "#/definitions/AuthorizationConfig" }, - "Type" : { - "type" : "string", - "description" : "The proxy type. The only supported value is ``APPMESH``." + "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" + }, + "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" } - }, - "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)" + } }, "RepositoryCredentials" : { + "description" : "The repository credentials for private registry authentication.", + "additionalProperties" : false, "type" : "object", "properties" : { "CredentialsParameter" : { - "type" : "string", - "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." + "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" } - }, + } + }, + "KeyValuePair" : { + "description" : "A key-value pair object.", "additionalProperties" : false, - "description" : "The repository credentials for private registry authentication." + "type" : "object", + "properties" : { + "Value" : { + "description" : "The value of the key-value pair. For environment variables, this is the value of the environment variable.", + "type" : "string" + }, + "Name" : { + "description" : "The name of the key-value pair. For environment variables, this is the name of the environment variable.", + "type" : "string" + } + } }, - "ResourceRequirement" : { + "Device" : { + "description" : "The ``Device`` property specifies an object representing a container instance host device.", + "additionalProperties" : false, "type" : "object", - "required" : [ "Type", "Value" ], "properties" : { - "Type" : { - "type" : "string", - "description" : "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." + "HostPath" : { + "description" : "The path for the device on the host container instance.", + "type" : "string" }, - "Value" : { - "type" : "string", - "description" : "The value for the specified resource type.\n If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." + "Permissions" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "type" : "string" + } + }, + "ContainerPath" : { + "description" : "The path inside the container at which to expose the host device.", + "type" : "string" + } + } + }, + "LinuxParameters" : { + "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).", + "additionalProperties" : false, + "type" : "object", + "properties" : { + "Capabilities" : { + "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.", + "$ref" : "#/definitions/KernelCapabilities" + }, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/Tmpfs" + } + }, + "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" + }, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/Device" + } + }, + "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" } - }, - "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*" + } }, - "RuntimePlatform" : { + "Ulimit" : { + "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.", + "additionalProperties" : false, "type" : "object", + "required" : [ "HardLimit", "Name", "SoftLimit" ], "properties" : { - "CpuArchitecture" : { - "type" : "string", - "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." + "SoftLimit" : { + "description" : "The soft limit for the ``ulimit`` type.", + "type" : "integer" }, - "OperatingSystemFamily" : { - "type" : "string", - "description" : "The operating system." + "HardLimit" : { + "description" : "The hard limit for the ``ulimit`` type.", + "type" : "integer" + }, + "Name" : { + "description" : "The ``type`` of the ``ulimit``.", + "type" : "string" } - }, - "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*." + } }, - "Secret" : { + "HostVolumeProperties" : { + "description" : "The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.", + "additionalProperties" : false, "type" : "object", - "required" : [ "Name", "ValueFrom" ], "properties" : { - "Name" : { - "type" : "string", - "description" : "The name of the secret." - }, - "ValueFrom" : { - "type" : "string", - "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." + "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" } - }, - "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*." + } }, - "TaskDefinitionPlacementConstraint" : { + "MountPoint" : { + "description" : "The details for a volume mount point that's used in a container definition.", + "additionalProperties" : false, "type" : "object", - "required" : [ "Type" ], "properties" : { - "Type" : { - "type" : "string", - "description" : "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates." + "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" }, - "Expression" : { - "type" : "string", - "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*." + "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" + }, + "ContainerPath" : { + "description" : "The path on the container to mount the host volume at.", + "type" : "string" } - }, - "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." + } }, - "Tmpfs" : { + "Secret" : { + "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*.", + "additionalProperties" : false, "type" : "object", - "required" : [ "Size" ], + "required" : [ "Name", "ValueFrom" ], "properties" : { - "ContainerPath" : { - "type" : "string", - "description" : "The absolute file path where the tmpfs volume is to be mounted." - }, - "MountOptions" : { - "type" : "array", - "insertionOrder" : false, - "items" : { - "type" : "string" - }, - "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\"``" + "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" }, - "Size" : { - "type" : "integer", - "description" : "The maximum size (in MiB) of the tmpfs volume." + "Name" : { + "description" : "The name of the secret.", + "type" : "string" } - }, - "additionalProperties" : false, - "description" : "The container path, mount options, and size of the tmpfs mount." + } }, - "Ulimit" : { + "ProxyConfiguration" : { + "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)", + "additionalProperties" : false, "type" : "object", - "required" : [ "HardLimit", "Name", "SoftLimit" ], + "required" : [ "ContainerName" ], "properties" : { - "HardLimit" : { - "type" : "integer", - "description" : "The hard limit for the ``ulimit`` type." + "ProxyConfigurationProperties" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/KeyValuePair" + } }, - "Name" : { - "type" : "string", - "description" : "The ``type`` of the ``ulimit``." + "Type" : { + "description" : "The proxy type. The only supported value is ``APPMESH``.", + "type" : "string" }, - "SoftLimit" : { - "type" : "integer", - "description" : "The soft limit for the ``ulimit`` type." + "ContainerName" : { + "description" : "The name of the container that will serve as the App Mesh proxy.", + "type" : "string" } - }, - "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." + } }, "Volume" : { + "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).", + "additionalProperties" : false, "type" : "object", "properties" : { + "EFSVolumeConfiguration" : { + "description" : "This parameter is specified when you use an Amazon Elastic File System file system for task storage.", + "$ref" : "#/definitions/EFSVolumeConfiguration" + }, + "Host" : { + "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``.", + "$ref" : "#/definitions/HostVolumeProperties" + }, "ConfiguredAtLaunch" : { - "type" : "boolean", - "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." + "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", - "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", - "description" : "This parameter is specified when you use an Amazon Elastic File System file system for task storage." + "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.", + "$ref" : "#/definitions/DockerVolumeConfiguration" }, "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", - "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``." + "description" : "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.", + "$ref" : "#/definitions/FSxWindowsFileServerVolumeConfiguration" }, "Name" : { - "type" : "string", - "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." + "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" } - }, + } + }, + "EnvironmentFile" : { + "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.", "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)." + "type" : "object", + "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" + } + } }, - "VolumeFrom" : { + "ResourceRequirement" : { + "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*", + "additionalProperties" : false, "type" : "object", + "required" : [ "Type", "Value" ], "properties" : { - "ReadOnly" : { - "type" : "boolean", - "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" : { + "description" : "The type of resource to assign to a container.", + "type" : "string" }, - "SourceContainer" : { - "type" : "string", - "description" : "The name of another container within the same task definition to mount volumes from." + "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" } - }, + } + }, + "InferenceAccelerator" : { + "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*.", "additionalProperties" : false, - "description" : "Details on a data volume from another container in the same task definition." + "type" : "object", + "properties" : { + "DeviceType" : { + "description" : "The Elastic Inference accelerator type to use.", + "type" : "string" + }, + "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" + } + } }, "Tag" : { + "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.", + "additionalProperties" : false, "type" : "object", "properties" : { - "Key" : { - "type" : "string", - "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" : "string", - "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)." + "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" + }, + "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" + } + } + }, + "EphemeralStorage" : { + "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.", + "additionalProperties" : false, + "type" : "object", + "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" } - }, + } + }, + "FSxWindowsFileServerVolumeConfiguration" : { + "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*.", "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." + "type" : "object", + "required" : [ "FileSystemId", "RootDirectory" ], + "properties" : { + "AuthorizationConfig" : { + "description" : "The authorization configuration details for the Amazon FSx for Windows File Server file system.", + "$ref" : "#/definitions/FSxAuthorizationConfig" + }, + "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" + } + } } }, - "additionalProperties" : false, "properties" : { - "TaskDefinitionArn" : { - "description" : "", + "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" }, - "Family" : { - "type" : "string", - "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." - }, - "ContainerDefinitions" : { - "type" : "array", - "insertionOrder" : false, - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/ContainerDefinition" - }, - "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" : "string", - "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." - }, - "ExecutionRoleArn" : { - "type" : "string", - "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*." - }, - "EphemeralStorage" : { - "$ref" : "#/definitions/EphemeralStorage", - "description" : "The ephemeral storage settings to use for tasks run with the task definition." + "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" }, "InferenceAccelerators" : { - "type" : "array", - "insertionOrder" : false, "uniqueItems" : true, + "description" : "The Elastic Inference accelerators to use for the containers in the task.", + "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/InferenceAccelerator" - }, - "description" : "The Elastic Inference accelerators to use for the containers in the task." + } }, "Memory" : { - "type" : "string", - "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" : "string", - "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*." + "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" }, "PlacementConstraints" : { - "type" : "array", - "insertionOrder" : false, "uniqueItems" : true, + "description" : "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong.", + "insertionOrder" : false, + "type" : "array", "items" : { "$ref" : "#/definitions/TaskDefinitionPlacementConstraint" - }, - "description" : "An array of placement constraint objects to use for tasks.\n This parameter isn't supported for tasks run on FARGATElong." + } }, - "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*." + "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" }, "RequiresCompatibilities" : { - "type" : "array", - "insertionOrder" : false, "uniqueItems" : true, + "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, + "type" : "array", "items" : { "type" : "string" - }, - "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*." + } }, - "TaskRoleArn" : { - "type" : "string", - "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*." + "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, ```` 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" + }, + "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" + }, + "RuntimePlatform" : { + "description" : "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.", + "$ref" : "#/definitions/RuntimePlatform" + }, + "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*.", + "$ref" : "#/definitions/ProxyConfiguration" }, "Volumes" : { - "type" : "array", - "insertionOrder" : false, "uniqueItems" : true, + "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, + "type" : "array", "items" : { "$ref" : "#/definitions/Volume" - }, - "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." + } }, - "PidMode" : { - "type" : "string", - "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." + "ContainerDefinitions" : { + "uniqueItems" : true, + "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, + "type" : "array", + "items" : { + "$ref" : "#/definitions/ContainerDefinition" + } }, - "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." + "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" }, - "IpcMode" : { - "type" : "string", - "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." + "EphemeralStorage" : { + "description" : "The ephemeral storage settings to use for tasks run with the task definition.", + "$ref" : "#/definitions/EphemeralStorage" }, "Tags" : { - "type" : "array", + "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, + "type" : "array", "items" : { "$ref" : "#/definitions/Tag" - }, - "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." - } - }, - "tagging" : { - "taggable" : true, - "tagOnCreate" : true, - "tagUpdatable" : true, - "cloudFormationSystemTags" : true, - "tagProperty" : "/properties/Tags" - }, - "createOnlyProperties" : [ "/properties/Family", "/properties/ContainerDefinitions", "/properties/Cpu", "/properties/ExecutionRoleArn", "/properties/InferenceAccelerators", "/properties/Memory", "/properties/NetworkMode", "/properties/PlacementConstraints", "/properties/ProxyConfiguration", "/properties/RequiresCompatibilities", "/properties/RuntimePlatform", "/properties/TaskRoleArn", "/properties/Volumes", "/properties/PidMode", "/properties/IpcMode", "/properties/EphemeralStorage" ], - "readOnlyProperties" : [ "/properties/TaskDefinitionArn" ], - "primaryIdentifier" : [ "/properties/TaskDefinitionArn" ], - "propertyTransform" : { - "/properties/TaskRoleArn" : "TaskRoleArn $OR $split(TaskRoleArn, \"role/\")[-1]" - }, - "handlers" : { - "create" : { - "permissions" : [ "ecs:RegisterTaskDefinition", "ecs:DescribeTaskDefinition", "ecs:TagResource", "iam:GetRole", "iam:PassRole" ] - }, - "read" : { - "permissions" : [ "ecs:DescribeTaskDefinition" ] - }, - "update" : { - "permissions" : [ "ecs:TagResource", "ecs:UntagResource", "ecs:ListTagsForResource", "ecs:DescribeTaskDefinition", "iam:GetRole", "iam:PassRole" ] + } }, - "delete" : { - "permissions" : [ "ecs:DeregisterTaskDefinition", "ecs:DescribeTaskDefinition", "iam:GetRole", "iam:PassRole" ] - }, - "list" : { - "permissions" : [ "ecs:ListTaskDefinitions", "ecs:DescribeTaskDefinition" ] + "TaskDefinitionArn" : { + "description" : "", + "type" : "string" } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-eks-cluster.json b/aws-cloudformation-schema/aws-eks-cluster.json index 7dcf274c14..af98e54b83 100644 --- a/aws-cloudformation-schema/aws-eks-cluster.json +++ b/aws-cloudformation-schema/aws-eks-cluster.json @@ -1,214 +1,141 @@ { - "tagging" : { - "taggable" : true, - "tagOnCreate" : true, - "tagUpdatable" : true, - "tagProperty" : "/properties/Tags", - "cloudFormationSystemTags" : true - }, "typeName" : "AWS::EKS::Cluster", - "readOnlyProperties" : [ "/properties/Id", "/properties/Arn", "/properties/Endpoint", "/properties/CertificateAuthorityData", "/properties/ClusterSecurityGroupId", "/properties/EncryptionConfigKeyArn", "/properties/OpenIdConnectIssuerUrl", "/properties/KubernetesNetworkConfig/ServiceIpv6Cidr" ], "description" : "An object representing an Amazon EKS cluster.", - "createOnlyProperties" : [ "/properties/OutpostConfig", "/properties/EncryptionConfig", "/properties/KubernetesNetworkConfig", "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", "/properties/Name", "/properties/RoleArn" ], - "primaryIdentifier" : [ "/properties/Name" ], - "required" : [ "RoleArn", "ResourcesVpcConfig" ], "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-eks.git", - "handlers" : { - "read" : { - "permissions" : [ "eks:DescribeCluster" ] - }, - "create" : { - "permissions" : [ "eks:CreateCluster", "eks:DescribeCluster", "eks:TagResource", "iam:PassRole", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:CreateServiceLinkedRole", "iam:CreateInstanceProfile", "iam:TagInstanceProfile", "iam:AddRoleToInstanceProfile", "iam:GetInstanceProfile", "iam:DeleteInstanceProfile", "iam:RemoveRoleFromInstanceProfile", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "kms:DescribeKey", "kms:CreateGrant" ] - }, - "update" : { - "permissions" : [ "iam:PassRole", "eks:UpdateClusterConfig", "eks:UpdateClusterVersion", "eks:DescribeCluster", "eks:DescribeUpdate", "eks:TagResource", "eks:UntagResource" ], - "timeoutInMinutes" : 180 - }, - "list" : { - "permissions" : [ "eks:ListClusters" ] - }, - "delete" : { - "permissions" : [ "eks:DeleteCluster", "eks:DescribeCluster" ] - } - }, - "writeOnlyProperties" : [ "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions" ], - "additionalProperties" : false, "definitions" : { - "Logging" : { - "description" : "Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "ClusterLogging" : { - "description" : "The cluster control plane logging configuration for your cluster. ", - "$ref" : "#/definitions/ClusterLogging" - } - } - }, - "EnabledTypes" : { - "description" : "Enable control plane logs for your cluster, all log types will be disabled if the array is empty", - "insertionOrder" : false, - "type" : "array", - "items" : { - "$ref" : "#/definitions/LoggingTypeConfig" - } - }, "Tag" : { "description" : "A key-value pair to associate with a resource.", - "additionalProperties" : false, "type" : "object", "properties" : { - "Value" : { - "minLength" : 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" : "string", - "maxLength" : 256 - }, "Key" : { - "minLength" : 1, - "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters 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", + "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "minLength" : 1, "maxLength" : 128 + }, + "Value" : { + "type" : "string", + "description" : "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.", + "minLength" : 0, + "maxLength" : 256 } }, - "required" : [ "Key", "Value" ] + "required" : [ "Key", "Value" ], + "additionalProperties" : false }, - "ControlPlanePlacement" : { - "description" : "Specify the placement group of the control plane machines for your cluster.", - "additionalProperties" : false, + "Provider" : { "type" : "object", - "properties" : { - "GroupName" : { - "description" : "Specify the placement group name of the control place machines for your cluster.", - "type" : "string" - } - } - }, - "OutpostConfig" : { - "description" : "An object representing the Outpost configuration to use for AWS EKS outpost cluster.", "additionalProperties" : false, - "type" : "object", "properties" : { - "OutpostArns" : { - "description" : "Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.", - "insertionOrder" : false, - "type" : "array", - "items" : { - "minItems" : 1, - "type" : "string" - } - }, - "ControlPlanePlacement" : { - "description" : "Specify the placement group of the control plane machines for your cluster.", - "$ref" : "#/definitions/ControlPlanePlacement" - }, - "ControlPlaneInstanceType" : { - "description" : "Specify the Instance type of the machines that should be used to create your cluster.", + "KeyArn" : { + "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" : "string" } - }, - "required" : [ "OutpostArns", "ControlPlaneInstanceType" ] - }, - "AccessConfig" : { - "description" : "An object representing the Access Config to use for the cluster.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "AuthenticationMode" : { - "description" : "Specify the authentication mode that should be used to create your cluster.", - "type" : "string", - "enum" : [ "CONFIG_MAP", "API_AND_CONFIG_MAP", "API" ] - }, - "BootstrapClusterCreatorAdminPermissions" : { - "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" : "boolean" - } } }, "EncryptionConfig" : { "description" : "The encryption configuration for the cluster", - "additionalProperties" : false, "type" : "object", "properties" : { + "Provider" : { + "description" : "The encryption provider for the cluster.", + "$ref" : "#/definitions/Provider" + }, "Resources" : { "description" : "Specifies the resources to be encrypted. The only supported value is \"secrets\".", - "insertionOrder" : false, "type" : "array", + "insertionOrder" : false, "items" : { "type" : "string" } - }, - "Provider" : { - "description" : "The encryption provider for the cluster.", - "$ref" : "#/definitions/Provider" - } - } - }, - "LoggingTypeConfig" : { - "description" : "Enabled Logging Type", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "Type" : { - "description" : "name of the log type", - "type" : "string", - "enum" : [ "api", "audit", "authenticator", "controllerManager", "scheduler" ] } - } + }, + "additionalProperties" : false }, "ResourcesVpcConfig" : { "description" : "An object representing the VPC configuration to use for an Amazon EKS cluster.", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { + "EndpointPrivateAccess" : { + "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.", + "type" : "boolean" + }, "EndpointPublicAccess" : { "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.", "type" : "boolean" }, "PublicAccessCidrs" : { "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.", - "insertionOrder" : false, "type" : "array", + "insertionOrder" : false, "items" : { - "minItems" : 1, - "type" : "string" + "type" : "string", + "minItems" : 1 } }, - "EndpointPrivateAccess" : { - "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.", - "type" : "boolean" - }, "SecurityGroupIds" : { "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.", - "insertionOrder" : false, "type" : "array", + "insertionOrder" : false, "items" : { - "minItems" : 1, - "type" : "string" + "type" : "string", + "minItems" : 1 } }, "SubnetIds" : { "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.", - "insertionOrder" : false, "type" : "array", + "insertionOrder" : false, "items" : { - "minItems" : 1, - "type" : "string" + "type" : "string", + "minItems" : 1 } } }, "required" : [ "SubnetIds" ] }, + "LoggingTypeConfig" : { + "description" : "Enabled Logging Type", + "type" : "object", + "properties" : { + "Type" : { + "description" : "name of the log type", + "type" : "string", + "enum" : [ "api", "audit", "authenticator", "controllerManager", "scheduler" ] + } + }, + "additionalProperties" : false + }, + "EnabledTypes" : { + "description" : "Enable control plane logs for your cluster, all log types will be disabled if the array is empty", + "type" : "array", + "insertionOrder" : false, + "items" : { + "$ref" : "#/definitions/LoggingTypeConfig" + } + }, "ClusterLogging" : { "description" : "The cluster control plane logging configuration for your cluster. ", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { "EnabledTypes" : { "$ref" : "#/definitions/EnabledTypes" } } }, + "Logging" : { + "description" : "Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "ClusterLogging" : { + "description" : "The cluster control plane logging configuration for your cluster. ", + "$ref" : "#/definitions/ClusterLogging" + } + } + }, "KubernetesNetworkConfig" : { "description" : "The Kubernetes network configuration for the cluster.", "additionalProperties" : false, @@ -229,93 +156,170 @@ } } }, - "Provider" : { + "ControlPlanePlacement" : { + "description" : "Specify the placement group of the control plane machines for your cluster.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "GroupName" : { + "description" : "Specify the placement group name of the control place machines for your cluster.", + "type" : "string" + } + } + }, + "OutpostConfig" : { + "description" : "An object representing the Outpost configuration to use for AWS EKS outpost cluster.", "additionalProperties" : false, "type" : "object", "properties" : { - "KeyArn" : { - "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.", + "OutpostArns" : { + "description" : "Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster.", + "type" : "array", + "insertionOrder" : false, + "items" : { + "type" : "string", + "minItems" : 1 + } + }, + "ControlPlaneInstanceType" : { + "description" : "Specify the Instance type of the machines that should be used to create your cluster.", "type" : "string" + }, + "ControlPlanePlacement" : { + "description" : "Specify the placement group of the control plane machines for your cluster.", + "$ref" : "#/definitions/ControlPlanePlacement" + } + }, + "required" : [ "OutpostArns", "ControlPlaneInstanceType" ] + }, + "AccessConfig" : { + "description" : "An object representing the Access Config to use for the cluster.", + "additionalProperties" : false, + "type" : "object", + "properties" : { + "BootstrapClusterCreatorAdminPermissions" : { + "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" : "boolean" + }, + "AuthenticationMode" : { + "description" : "Specify the authentication mode that should be used to create your cluster.", + "type" : "string", + "enum" : [ "CONFIG_MAP", "API_AND_CONFIG_MAP", "API" ] } } } }, "properties" : { - "Logging" : { - "$ref" : "#/definitions/Logging" - }, - "EncryptionConfigKeyArn" : { - "description" : "Amazon Resource Name (ARN) or alias of the customer master key (CMK).", - "type" : "string" - }, - "AccessConfig" : { - "$ref" : "#/definitions/AccessConfig" - }, - "CertificateAuthorityData" : { - "description" : "The certificate-authority-data for your cluster.", - "type" : "string" - }, "EncryptionConfig" : { - "insertionOrder" : false, "type" : "array", + "insertionOrder" : false, "items" : { - "maxItems" : 1, - "$ref" : "#/definitions/EncryptionConfig" + "$ref" : "#/definitions/EncryptionConfig", + "maxItems" : 1 } }, "KubernetesNetworkConfig" : { "$ref" : "#/definitions/KubernetesNetworkConfig" }, - "RoleArn" : { - "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.", - "type" : "string" + "Logging" : { + "$ref" : "#/definitions/Logging" }, "Name" : { - "minLength" : 1, - "pattern" : "^[0-9A-Za-z][A-Za-z0-9\\-_]*", "description" : "The unique name to give to your cluster.", "type" : "string", + "pattern" : "^[0-9A-Za-z][A-Za-z0-9\\-_]*", + "minLength" : 1, "maxLength" : 100 }, - "Endpoint" : { - "description" : "The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.", - "type" : "string" - }, - "Version" : { - "pattern" : "1\\.\\d\\d", - "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" : "string" - }, - "ClusterSecurityGroupId" : { - "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.", - "type" : "string" - }, "Id" : { "description" : "The unique ID given to your cluster.", "type" : "string" }, + "ResourcesVpcConfig" : { + "$ref" : "#/definitions/ResourcesVpcConfig" + }, "OutpostConfig" : { "$ref" : "#/definitions/OutpostConfig" }, - "Arn" : { - "description" : "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.", + "AccessConfig" : { + "$ref" : "#/definitions/AccessConfig" + }, + "RoleArn" : { + "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.", "type" : "string" }, - "ResourcesVpcConfig" : { - "$ref" : "#/definitions/ResourcesVpcConfig" + "Version" : { + "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" : "string", + "pattern" : "1\\.\\d\\d" }, "Tags" : { - "uniqueItems" : true, "description" : "An array of key-value pairs to apply to this resource.", - "insertionOrder" : false, "type" : "array", + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } }, + "Arn" : { + "description" : "The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.", + "type" : "string" + }, + "Endpoint" : { + "description" : "The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.", + "type" : "string" + }, + "CertificateAuthorityData" : { + "description" : "The certificate-authority-data for your cluster.", + "type" : "string" + }, + "ClusterSecurityGroupId" : { + "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.", + "type" : "string" + }, + "EncryptionConfigKeyArn" : { + "description" : "Amazon Resource Name (ARN) or alias of the customer master key (CMK).", + "type" : "string" + }, "OpenIdConnectIssuerUrl" : { "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.", "type" : "string" + }, + "BootstrapSelfManagedAddons" : { + "description" : "Set this value to false to avoid creating the default networking addons when the cluster is created.", + "type" : "boolean" + } + }, + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : true, + "tagProperty" : "/properties/Tags" + }, + "additionalProperties" : false, + "required" : [ "RoleArn", "ResourcesVpcConfig" ], + "primaryIdentifier" : [ "/properties/Name" ], + "createOnlyProperties" : [ "/properties/OutpostConfig", "/properties/EncryptionConfig", "/properties/KubernetesNetworkConfig", "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", "/properties/Name", "/properties/RoleArn", "/properties/BootstrapSelfManagedAddons" ], + "readOnlyProperties" : [ "/properties/Id", "/properties/Arn", "/properties/Endpoint", "/properties/CertificateAuthorityData", "/properties/ClusterSecurityGroupId", "/properties/EncryptionConfigKeyArn", "/properties/OpenIdConnectIssuerUrl", "/properties/KubernetesNetworkConfig/ServiceIpv6Cidr" ], + "writeOnlyProperties" : [ "/properties/AccessConfig/BootstrapClusterCreatorAdminPermissions", "/properties/BootstrapSelfManagedAddons" ], + "handlers" : { + "create" : { + "permissions" : [ "eks:CreateCluster", "eks:DescribeCluster", "eks:TagResource", "iam:PassRole", "iam:GetRole", "iam:ListAttachedRolePolicies", "iam:CreateServiceLinkedRole", "iam:CreateInstanceProfile", "iam:TagInstanceProfile", "iam:AddRoleToInstanceProfile", "iam:GetInstanceProfile", "iam:DeleteInstanceProfile", "iam:RemoveRoleFromInstanceProfile", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "kms:DescribeKey", "kms:CreateGrant" ] + }, + "read" : { + "permissions" : [ "eks:DescribeCluster" ] + }, + "update" : { + "permissions" : [ "iam:PassRole", "eks:UpdateClusterConfig", "eks:UpdateClusterVersion", "eks:DescribeCluster", "eks:DescribeUpdate", "eks:TagResource", "eks:UntagResource" ], + "timeoutInMinutes" : 180 + }, + "delete" : { + "permissions" : [ "eks:DeleteCluster", "eks:DescribeCluster" ] + }, + "list" : { + "permissions" : [ "eks:ListClusters" ] } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-elasticbeanstalk-environment.json b/aws-cloudformation-schema/aws-elasticbeanstalk-environment.json index ca824e5dfc..8af7b8c1db 100644 --- a/aws-cloudformation-schema/aws-elasticbeanstalk-environment.json +++ b/aws-cloudformation-schema/aws-elasticbeanstalk-environment.json @@ -18,15 +18,15 @@ "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:DescribeConfigurationSettings", "elasticbeanstalk:ListTagsForResource" ] }, "create" : { - "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:CreateEnvironment", "iam:PassRole" ], + "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:CreateEnvironment", "elasticbeanstalk:AddTags", "elasticbeanstalk:ListTagsForResource", "iam:PassRole" ], "timeoutInMinutes" : 120 }, "update" : { - "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:UpdateEnvironment", "elasticbeanstalk:UpdateTagsForResource", "elasticbeanstalk:AssociateEnvironmentOperationsRole", "elasticbeanstalk:DisassociateEnvironmentOperationsRole", "iam:PassRole" ], + "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:UpdateEnvironment", "elasticbeanstalk:UpdateTagsForResource", "elasticbeanstalk:AssociateEnvironmentOperationsRole", "elasticbeanstalk:DisassociateEnvironmentOperationsRole", "elasticbeanstalk:AddTags", "elasticbeanstalk:ListTagsForResource", "iam:PassRole" ], "timeoutInMinutes" : 300 }, "list" : { - "permissions" : [ "elasticbeanstalk:DescribeEnvironments" ] + "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:ListTagsForResource" ] }, "delete" : { "permissions" : [ "elasticbeanstalk:DescribeEnvironments", "elasticbeanstalk:TerminateEnvironment" ], diff --git a/aws-cloudformation-schema/aws-emrserverless-application.json b/aws-cloudformation-schema/aws-emrserverless-application.json index 169d729b07..0ffc010e3b 100644 --- a/aws-cloudformation-schema/aws-emrserverless-application.json +++ b/aws-cloudformation-schema/aws-emrserverless-application.json @@ -188,6 +188,10 @@ "Disk" : { "description" : "Per worker Disk resource. GB is the only supported unit and specifying GB is optional", "$ref" : "#/definitions/DiskSize" + }, + "DiskType" : { + "description" : "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional", + "$ref" : "#/definitions/DiskType" } }, "required" : [ "Cpu", "Memory" ] @@ -410,6 +414,11 @@ "maxLength" : 15, "pattern" : "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" }, + "DiskType" : { + "description" : "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional", + "type" : "string", + "pattern" : "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$" + }, "WorkerTypeSpecificationInput" : { "type" : "object", "description" : "The specifications for a worker type.", @@ -492,7 +501,8 @@ }, "Arn" : { "description" : "The Amazon Resource Name (ARN) of the EMR Serverless Application.", - "type" : "string" + "type" : "string", + "pattern" : "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" }, "ApplicationId" : { "description" : "The ID of the EMR Serverless Application.", @@ -513,18 +523,20 @@ "primaryIdentifier" : [ "/properties/ApplicationId" ], "tagging" : { "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, "cloudFormationSystemTags" : false, "tagProperty" : "/properties/Tags" }, "handlers" : { "create" : { - "permissions" : [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*", "kms:ScheduleKeyDeletion", "kms:CancelKeyDeletion", "kms:GenerateDataKey", "kms:TagResource", "kms:UntagResource", "kms:Decrypt", "emr-serverless:CreateApplication", "emr-serverless:TagResource", "emr-serverless:GetApplication", "iam:CreateServiceLinkedRole", "ec2:CreateNetworkInterface", "ecr:BatchGetImage", "ecr:DescribeImages", "ecr:GetDownloadUrlForLayer" ] + "permissions" : [ "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", "kms:TagResource", "kms:UntagResource", "kms:Decrypt", "emr-serverless:CreateApplication", "emr-serverless:TagResource", "emr-serverless:GetApplication", "iam:CreateServiceLinkedRole", "ec2:CreateNetworkInterface", "ecr:BatchGetImage", "ecr:DescribeImages", "ecr:GetDownloadUrlForLayer" ] }, "read" : { "permissions" : [ "emr-serverless:GetApplication" ] }, "update" : { - "permissions" : [ "emr-serverless:UpdateApplication", "emr-serverless:TagResource", "emr-serverless:UntagResource", "emr-serverless:GetApplication", "ec2:CreateNetworkInterface", "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:ScheduleKeyDeletion", "kms:CancelKeyDeletion", "kms:GenerateDataKey", "kms:TagResource", "kms:UntagResource", "kms:Decrypt" ] + "permissions" : [ "emr-serverless:UpdateApplication", "emr-serverless:TagResource", "emr-serverless:UntagResource", "emr-serverless:GetApplication", "ec2:CreateNetworkInterface", "ecr:BatchGetImage", "ecr:DescribeImages", "ecr:GetDownloadUrlForLayer", "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", "kms:TagResource", "kms:UntagResource", "kms:Decrypt" ] }, "delete" : { "permissions" : [ "emr-serverless:DeleteApplication", "emr-serverless:GetApplication" ] diff --git a/aws-cloudformation-schema/aws-guardduty-filter.json b/aws-cloudformation-schema/aws-guardduty-filter.json index 4322314eac..cb7fb58b68 100644 --- a/aws-cloudformation-schema/aws-guardduty-filter.json +++ b/aws-cloudformation-schema/aws-guardduty-filter.json @@ -136,7 +136,7 @@ } } }, - "required" : [ "FindingCriteria" ], + "required" : [ "DetectorId", "Name", "FindingCriteria" ], "primaryIdentifier" : [ "/properties/DetectorId", "/properties/Name" ], "createOnlyProperties" : [ "/properties/DetectorId", "/properties/Name" ], "handlers" : { diff --git a/aws-cloudformation-schema/aws-guardduty-malwareprotectionplan.json b/aws-cloudformation-schema/aws-guardduty-malwareprotectionplan.json index 39bc9182f4..5938e07016 100644 --- a/aws-cloudformation-schema/aws-guardduty-malwareprotectionplan.json +++ b/aws-cloudformation-schema/aws-guardduty-malwareprotectionplan.json @@ -19,15 +19,15 @@ }, "Role" : { "type" : "string", - "description" : "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description" : "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "ProtectedResource" : { "$ref" : "#/definitions/CFNProtectedResource", - "description" : "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description" : "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "Actions" : { "$ref" : "#/definitions/CFNActions", - "description" : "Information about whether the tags will be added to the S3 object after scanning." + "description" : "Specifies the action that is to be applied to the Malware Protection plan resource." }, "CreatedAt" : { "type" : "string", @@ -35,17 +35,18 @@ }, "Status" : { "type" : "string", - "description" : "Malware Protection plan status." + "description" : "Status of the Malware Protection plan resource." }, "StatusReasons" : { "type" : "array", "items" : { "$ref" : "#/definitions/CFNStatusReasons" }, - "description" : "Information about the issue code and message associated to the status of your Malware Protection plan." + "description" : "Status details associated with the Malware Protection plan resource status." }, "Tags" : { "type" : "array", + "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" } @@ -97,7 +98,7 @@ "properties" : { "Tagging" : { "$ref" : "#/definitions/CFNTagging", - "description" : "Indicates whether the scanned S3 object will have tags about the scan result." + "description" : "Contains information about tagging status of the Malware Protection plan resource." } } }, @@ -107,7 +108,7 @@ "properties" : { "Status" : { "type" : "string", - "description" : "Indicates whether or not the tags will added." + "description" : "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object." } } }, @@ -117,7 +118,7 @@ "properties" : { "Code" : { "type" : "string", - "description" : "Issue code." + "description" : "The status code of the Malware Protection plan." }, "Message" : { "type" : "string", diff --git a/aws-cloudformation-schema/aws-iot-authorizer.json b/aws-cloudformation-schema/aws-iot-authorizer.json index f8b6c8b997..79d1d39fe6 100644 --- a/aws-cloudformation-schema/aws-iot-authorizer.json +++ b/aws-cloudformation-schema/aws-iot-authorizer.json @@ -55,7 +55,8 @@ }, "Tags" : { "type" : "array", - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-iot-cacertificate.json b/aws-cloudformation-schema/aws-iot-cacertificate.json index aa8dcbe306..6a3c3b14d4 100644 --- a/aws-cloudformation-schema/aws-iot-cacertificate.json +++ b/aws-cloudformation-schema/aws-iot-cacertificate.json @@ -89,6 +89,7 @@ "Tags" : { "description" : "An array of key-value pairs to apply to this resource.", "type" : "array", + "uniqueItems" : true, "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" diff --git a/aws-cloudformation-schema/aws-iot-certificateprovider.json b/aws-cloudformation-schema/aws-iot-certificateprovider.json index f0f2c4e554..b84964420e 100644 --- a/aws-cloudformation-schema/aws-iot-certificateprovider.json +++ b/aws-cloudformation-schema/aws-iot-certificateprovider.json @@ -54,7 +54,8 @@ "description" : "An array of key-value pairs to apply to this resource.", "type" : "array", "maxItems" : 50, - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-iot-domainconfiguration.json b/aws-cloudformation-schema/aws-iot-domainconfiguration.json index 64ab3b0163..a13267ae1f 100644 --- a/aws-cloudformation-schema/aws-iot-domainconfiguration.json +++ b/aws-cloudformation-schema/aws-iot-domainconfiguration.json @@ -131,7 +131,8 @@ }, "Tags" : { "type" : "array", - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-iot-policy.json b/aws-cloudformation-schema/aws-iot-policy.json index 4db11c482d..d4f10144c3 100644 --- a/aws-cloudformation-schema/aws-iot-policy.json +++ b/aws-cloudformation-schema/aws-iot-policy.json @@ -41,7 +41,8 @@ }, "Tags" : { "type" : "array", - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-iot-provisioningtemplate.json b/aws-cloudformation-schema/aws-iot-provisioningtemplate.json index d6e6011e2a..429ad02076 100644 --- a/aws-cloudformation-schema/aws-iot-provisioningtemplate.json +++ b/aws-cloudformation-schema/aws-iot-provisioningtemplate.json @@ -12,7 +12,8 @@ "PayloadVersion" : { "type" : "string" } - } + }, + "additionalProperties" : false }, "Tag" : { "type" : "object", @@ -60,7 +61,8 @@ }, "Tags" : { "type" : "array", - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-iot-rolealias.json b/aws-cloudformation-schema/aws-iot-rolealias.json index 65ba0f7edc..19bc440bf2 100644 --- a/aws-cloudformation-schema/aws-iot-rolealias.json +++ b/aws-cloudformation-schema/aws-iot-rolealias.json @@ -53,7 +53,8 @@ }, "Tags" : { "type" : "array", - "insertionOrder" : true, + "uniqueItems" : true, + "insertionOrder" : false, "items" : { "$ref" : "#/definitions/Tag" } diff --git a/aws-cloudformation-schema/aws-kinesisanalyticsv2-application.json b/aws-cloudformation-schema/aws-kinesisanalyticsv2-application.json index 19f8169856..95c1969937 100644 --- a/aws-cloudformation-schema/aws-kinesisanalyticsv2-application.json +++ b/aws-cloudformation-schema/aws-kinesisanalyticsv2-application.json @@ -82,6 +82,10 @@ "description" : "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.", "$ref" : "#/definitions/ApplicationSnapshotConfiguration" }, + "ApplicationSystemRollbackConfiguration" : { + "description" : "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "$ref" : "#/definitions/ApplicationSystemRollbackConfiguration" + }, "EnvironmentProperties" : { "description" : "Describes execution properties for a Flink-based Kinesis Data Analytics application.", "$ref" : "#/definitions/EnvironmentProperties" @@ -224,6 +228,18 @@ }, "required" : [ "SnapshotsEnabled" ] }, + "ApplicationSystemRollbackConfiguration" : { + "description" : "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "RollbackEnabled" : { + "description" : "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "type" : "boolean" + } + }, + "required" : [ "RollbackEnabled" ] + }, "EnvironmentProperties" : { "description" : "Describes execution properties for a Flink-based Kinesis Data Analytics application.", "type" : "object", diff --git a/aws-cloudformation-schema/aws-lambda-function.json b/aws-cloudformation-schema/aws-lambda-function.json index 4e41a9f1fa..cb4c709a1d 100644 --- a/aws-cloudformation-schema/aws-lambda-function.json +++ b/aws-cloudformation-schema/aws-lambda-function.json @@ -337,7 +337,7 @@ "type" : "string" }, "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).", + "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" }, "KmsKeyArn" : { diff --git a/aws-cloudformation-schema/aws-location-apikey.json b/aws-cloudformation-schema/aws-location-apikey.json index fd5c460307..442957c025 100644 --- a/aws-cloudformation-schema/aws-location-apikey.json +++ b/aws-cloudformation-schema/aws-location-apikey.json @@ -47,11 +47,11 @@ "type" : "object", "maxProperties" : 50, "patternProperties" : { - "^[a-zA-Z+-=._:/]+$" : { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" : { "type" : "string", "maxLength" : 256, "minLength" : 0, - "pattern" : "^[A-Za-z0-9 _=@:.+-/]*$" + "pattern" : "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" } }, "additionalProperties" : false diff --git a/aws-cloudformation-schema/aws-location-placeindex.json b/aws-cloudformation-schema/aws-location-placeindex.json index 49ad5831e7..45b2945251 100644 --- a/aws-cloudformation-schema/aws-location-placeindex.json +++ b/aws-cloudformation-schema/aws-location-placeindex.json @@ -23,11 +23,11 @@ "type" : "object", "maxProperties" : 50, "patternProperties" : { - "^[a-zA-Z+-=._:/]+$" : { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" : { "type" : "string", "maxLength" : 256, "minLength" : 0, - "pattern" : "^[A-Za-z0-9 _=@:.+-/]*$" + "pattern" : "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" } }, "additionalProperties" : false diff --git a/aws-cloudformation-schema/aws-location-routecalculator.json b/aws-cloudformation-schema/aws-location-routecalculator.json index f2e8d970c6..f59c4cb321 100644 --- a/aws-cloudformation-schema/aws-location-routecalculator.json +++ b/aws-cloudformation-schema/aws-location-routecalculator.json @@ -10,11 +10,11 @@ "type" : "object", "maxProperties" : 50, "patternProperties" : { - "^[a-zA-Z+-=._:/]+$" : { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" : { "type" : "string", "maxLength" : 256, "minLength" : 0, - "pattern" : "^[A-Za-z0-9 _=@:.+-/]*$" + "pattern" : "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" } }, "additionalProperties" : false diff --git a/aws-cloudformation-schema/aws-location-tracker.json b/aws-cloudformation-schema/aws-location-tracker.json index 4431874a47..d2ba1f99b4 100644 --- a/aws-cloudformation-schema/aws-location-tracker.json +++ b/aws-cloudformation-schema/aws-location-tracker.json @@ -14,11 +14,11 @@ "type" : "object", "maxProperties" : 50, "patternProperties" : { - "^[a-zA-Z+-=._:/]+$" : { + "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" : { "type" : "string", "maxLength" : 256, "minLength" : 0, - "pattern" : "^[A-Za-z0-9 _=@:.+-/]*$" + "pattern" : "^([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)$" } }, "additionalProperties" : false diff --git a/aws-cloudformation-schema/aws-networkfirewall-firewall.json b/aws-cloudformation-schema/aws-networkfirewall-firewall.json index d61fe6b24a..95880b19e7 100644 --- a/aws-cloudformation-schema/aws-networkfirewall-firewall.json +++ b/aws-cloudformation-schema/aws-networkfirewall-firewall.json @@ -124,7 +124,7 @@ "permissions" : [ "ec2:CreateVpcEndpoint", "ec2:DescribeVpcEndpoints", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "iam:CreateServiceLinkedRole", "network-firewall:CreateFirewall", "network-firewall:DescribeFirewallPolicy", "network-firewall:DescribeRuleGroup", "network-firewall:TagResource", "network-firewall:AssociateSubnets", "network-firewall:AssociateFirewallPolicy", "network-firewall:DescribeFirewall" ] }, "read" : { - "permissions" : [ "network-firewall:DescribeFirewall", "network-firewall:ListTagsForResources" ] + "permissions" : [ "network-firewall:DescribeFirewall", "network-firewall:ListTagsForResource" ] }, "update" : { "permissions" : [ "network-firewall:AssociateSubnets", "network-firewall:DisassociateSubnets", "network-firewall:UpdateFirewallDescription", "network-firewall:UpdateFirewallDeleteProtection", "network-firewall:UpdateSubnetChangeProtection", "network-firewall:UpdateFirewallPolicyChangeProtection", "network-firewall:AssociateFirewallPolicy", "network-firewall:TagResource", "network-firewall:UntagResource", "network-firewall:DescribeFirewall" ] diff --git a/aws-cloudformation-schema/aws-quicksight-dashboard.json b/aws-cloudformation-schema/aws-quicksight-dashboard.json index 62b594fc47..96be0d68c3 100644 --- a/aws-cloudformation-schema/aws-quicksight-dashboard.json +++ b/aws-cloudformation-schema/aws-quicksight-dashboard.json @@ -2035,12 +2035,6 @@ "SheetControlsOption" : { "$ref" : "#/definitions/SheetControlsOption" }, - "ExportToCSVOption" : { - "$ref" : "#/definitions/ExportToCSVOption" - }, - "DataPointMenuLabelOption" : { - "$ref" : "#/definitions/DataPointMenuLabelOption" - }, "DataPointDrillUpDownOption" : { "$ref" : "#/definitions/DataPointDrillUpDownOption" }, @@ -2050,18 +2044,24 @@ "VisualPublishOptions" : { "$ref" : "#/definitions/DashboardVisualPublishOptions" }, - "VisualMenuOption" : { - "$ref" : "#/definitions/VisualMenuOption" - }, - "DataPointTooltipOption" : { - "$ref" : "#/definitions/DataPointTooltipOption" - }, "VisualAxisSortOption" : { "$ref" : "#/definitions/VisualAxisSortOption" }, "ExportWithHiddenFieldsOption" : { "$ref" : "#/definitions/ExportWithHiddenFieldsOption" }, + "ExportToCSVOption" : { + "$ref" : "#/definitions/ExportToCSVOption" + }, + "DataPointMenuLabelOption" : { + "$ref" : "#/definitions/DataPointMenuLabelOption" + }, + "VisualMenuOption" : { + "$ref" : "#/definitions/VisualMenuOption" + }, + "DataPointTooltipOption" : { + "$ref" : "#/definitions/DataPointTooltipOption" + }, "SheetLayoutElementMaximizationOption" : { "$ref" : "#/definitions/SheetLayoutElementMaximizationOption" } diff --git a/aws-cloudformation-schema/aws-rds-dbcluster.json b/aws-cloudformation-schema/aws-rds-dbcluster.json index c0a1a05e5f..9a710384db 100644 --- a/aws-cloudformation-schema/aws-rds-dbcluster.json +++ b/aws-cloudformation-schema/aws-rds-dbcluster.json @@ -1,482 +1,449 @@ { "typeName" : "AWS::RDS::DBCluster", - "readOnlyProperties" : [ "/properties/DBClusterArn", "/properties/DBClusterResourceId", "/properties/Endpoint", "/properties/Endpoint/Address", "/properties/Endpoint/Port", "/properties/ReadEndpoint/Port", "/properties/ReadEndpoint/Address", "/properties/MasterUserSecret/SecretArn", "/properties/StorageThroughput" ], "description" : "The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.", - "createOnlyProperties" : [ "/properties/AvailabilityZones", "/properties/DBClusterIdentifier", "/properties/DBSubnetGroupName", "/properties/DBSystemId", "/properties/DatabaseName", "/properties/EngineMode", "/properties/KmsKeyId", "/properties/PubliclyAccessible", "/properties/RestoreToTime", "/properties/RestoreType", "/properties/SnapshotIdentifier", "/properties/SourceDBClusterIdentifier", "/properties/SourceRegion", "/properties/StorageEncrypted", "/properties/UseLatestRestorableTime" ], - "primaryIdentifier" : [ "/properties/DBClusterIdentifier" ], - "conditionalCreateOnlyProperties" : [ "/properties/Engine", "/properties/GlobalClusterIdentifier", "/properties/MasterUsername" ], "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-rds", - "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/SourceDBClusterIdentifier" : "$lowercase(SourceDBClusterIdentifier)", - "/properties/StorageType" : "$lowercase(StorageType)", - "/properties/MasterUserSecret/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\\/\", MasterUserSecret.KmsKeyId])", - "/properties/DBClusterIdentifier" : "$lowercase(DBClusterIdentifier)", - "/properties/EnableHttpEndpoint" : "$lowercase($string(EngineMode)) = 'serverless' ? EnableHttpEndpoint : ($lowercase($string(Engine)) = 'aurora-postgresql' ? EnableHttpEndpoint : false )", - "/properties/NetworkType" : "$lowercase(NetworkType)", - "/properties/PerformanceInsightsKmsKeyId" : "$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\\/\", PerformanceInsightsKmsKeyId])", - "/properties/DBSubnetGroupName" : "$lowercase(DBSubnetGroupName)", - "/properties/SnapshotIdentifier" : "$lowercase(SnapshotIdentifier)", - "/properties/PreferredMaintenanceWindow" : "$lowercase(PreferredMaintenanceWindow)", - "/properties/DBClusterParameterGroupName" : "$lowercase(DBClusterParameterGroupName)", - "/properties/EngineVersion" : "$join([$string(EngineVersion), \".*\"])", - "/properties/Engine" : "$lowercase(Engine)" - }, - "handlers" : { - "read" : { - "permissions" : [ "rds:DescribeDBClusters" ] - }, - "create" : { - "permissions" : [ "iam:CreateServiceLinkedRole", "iam:PassRole", "rds:AddRoleToDBCluster", "rds:AddTagsToResource", "rds:CreateDBCluster", "rds:CreateDBInstance", "rds:DescribeDBClusters", "rds:DescribeEvents", "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:RestoreDBClusterFromSnapshot", "rds:RestoreDBClusterToPointInTime", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], - "timeoutInMinutes" : 2160 - }, - "update" : { - "permissions" : [ "ec2:DescribeSecurityGroups", "iam:PassRole", "rds:AddRoleToDBCluster", "rds:AddTagsToResource", "rds:DescribeDBClusters", "rds:DescribeDBSubnetGroups", "rds:DescribeEvents", "rds:DescribeGlobalClusters", "rds:DisableHttpEndpoint", "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:ModifyDBInstance", "rds:RemoveFromGlobalCluster", "rds:RemoveRoleFromDBCluster", "rds:RemoveTagsFromResource", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], - "timeoutInMinutes" : 2160 + "properties" : { + "Endpoint" : { + "$ref" : "#/definitions/Endpoint" }, - "list" : { - "permissions" : [ "rds:DescribeDBClusters" ] + "ReadEndpoint" : { + "$ref" : "#/definitions/ReadEndpoint" }, - "delete" : { - "permissions" : [ "rds:CreateDBClusterSnapshot", "rds:DeleteDBCluster", "rds:DeleteDBInstance", "rds:DescribeDBClusters", "rds:DescribeGlobalClusters", "rds:RemoveFromGlobalCluster" ] - } - }, - "writeOnlyProperties" : [ "/properties/DBInstanceParameterGroupName", "/properties/MasterUserPassword", "/properties/RestoreToTime", "/properties/RestoreType", "/properties/SnapshotIdentifier", "/properties/SourceDBClusterIdentifier", "/properties/SourceRegion", "/properties/UseLatestRestorableTime" ], - "additionalProperties" : false, - "definitions" : { - "MasterUserSecret" : { - "additionalProperties" : false, - "type" : "object", - "properties" : { - "SecretArn" : { - "description" : "The Amazon Resource Name (ARN) of the secret.", - "type" : "string" - }, - "KmsKeyId" : { - "description" : "The AWS KMS key identifier that is used to encrypt the secret.", - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/KeyId" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/Arn" - } - } ], - "type" : "string" - } - } + "AllocatedStorage" : { + "description" : "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.", + "type" : "integer" }, - "Endpoint" : { - "additionalProperties" : false, - "type" : "object", - "properties" : { - "Address" : { - "description" : "The connection endpoint for the DB cluster.", - "type" : "string" - }, - "Port" : { - "description" : "The port number that will accept connections on this DB cluster.", - "type" : "string" - } + "AssociatedRoles" : { + "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.", + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DBClusterRole" } }, - "ServerlessV2ScalingConfiguration" : { - "description" : "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "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.", - "type" : "number" - }, - "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.", - "type" : "number" - } + "AvailabilityZones" : { + "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.", + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" } }, - "ScalingConfiguration" : { - "description" : "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "TimeoutAction" : { - "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" : "string" - }, - "SecondsBeforeTimeout" : { - "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.", - "type" : "integer" - }, - "SecondsUntilAutoPause" : { - "description" : "The time, in seconds, before an Aurora DB cluster in serverless mode is paused.", - "type" : "integer" - }, - "AutoPause" : { - "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).", - "type" : "boolean" - }, - "MinCapacity" : { - "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.", - "type" : "integer" - }, - "MaxCapacity" : { - "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.", - "type" : "integer" - } - } + "AutoMinorVersionUpgrade" : { + "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.", + "type" : "boolean" }, - "ReadEndpoint" : { - "additionalProperties" : false, - "type" : "object", - "properties" : { - "Address" : { - "description" : "The reader endpoint for the DB cluster.", - "type" : "string" - } - } + "BacktrackWindow" : { + "description" : "The target backtrack window, in seconds. To disable backtracking, set this value to 0.", + "default" : 0, + "minimum" : 0, + "type" : "integer" }, - "DBClusterRole" : { - "description" : "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "RoleArn" : { - "relationshipRef" : { - "typeName" : "AWS::IAM::Role", - "propertyPath" : "/properties/Arn" - }, - "description" : "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", - "type" : "string" - }, - "FeatureName" : { - "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.", - "type" : "string" - } - }, - "required" : [ "RoleArn" ] + "BackupRetentionPeriod" : { + "description" : "The number of days for which automated backups are retained.", + "default" : 1, + "minimum" : 1, + "type" : "integer" }, - "Tag" : { - "description" : "A key-value pair to associate with a resource.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "Value" : { - "minLength" : 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" : "string", - "maxLength" : 256 - }, - "Key" : { - "minLength" : 1, - "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters 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", - "maxLength" : 128 - } - }, - "required" : [ "Key" ] - } - }, - "properties" : { - "StorageEncrypted" : { - "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.", + "CopyTagsToSnapshot" : { + "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.", "type" : "boolean" }, - "DBSystemId" : { - "description" : "Reserved for future use.", + "DatabaseName" : { + "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.", "type" : "string" }, - "RestoreToTime" : { - "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", + "DBClusterArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) for the DB cluster." + }, + "DBClusterInstanceClass" : { + "description" : "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.", "type" : "string" }, - "EngineMode" : { - "description" : "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.", + "DBClusterResourceId" : { + "description" : "The AWS Region-unique, immutable identifier for the DB cluster.", "type" : "string" }, - "Port" : { - "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.", - "type" : "integer" + "DBInstanceParameterGroupName" : { + "description" : "The name of the DB parameter group to apply to all instances of the DB cluster.", + "type" : "string" + }, + "DBSystemId" : { + "description" : "Reserved for future use.", + "type" : "string" + }, + "GlobalClusterIdentifier" : { + "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.", + "type" : "string", + "pattern" : "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "minLength" : 0, + "maxLength" : 63 }, "DBClusterIdentifier" : { - "minLength" : 1, - "pattern" : "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", "description" : "The DB cluster identifier. This parameter is stored as a lowercase string.", "type" : "string", + "pattern" : "^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "minLength" : 1, "maxLength" : 63 }, - "StorageThroughput" : { - "description" : "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.", - "type" : "integer" + "DBClusterParameterGroupName" : { + "description" : "The name of the DB cluster parameter group to associate with this DB cluster.", + "type" : "string", + "default" : "default.aurora5.6" }, - "MonitoringInterval" : { - "default" : 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.", - "type" : "integer" + "DBSubnetGroupName" : { + "description" : "A DB subnet group that you want to associate with this DB cluster.", + "type" : "string" }, - "Endpoint" : { - "$ref" : "#/definitions/Endpoint" + "DeletionProtection" : { + "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.", + "type" : "boolean" }, - "ReplicationSourceIdentifier" : { - "description" : "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.", + "Domain" : { + "description" : "The Active Directory directory ID to create the DB cluster in.", "type" : "string" }, - "Engine" : { - "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", + "DomainIAMRoleName" : { + "description" : "Specify the name of the IAM role to be used when making API calls to the Directory Service.", "type" : "string" }, - "Tags" : { - "maxItems" : 50, - "uniqueItems" : true, - "description" : "An array of key-value pairs to apply to this resource.", - "insertionOrder" : false, + "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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.", "type" : "array", + "uniqueItems" : true, "items" : { - "$ref" : "#/definitions/Tag" + "type" : "string" } }, - "EngineVersion" : { - "description" : "The version number of the database engine to use.", - "type" : "string" - }, - "StorageType" : { - "description" : "Specifies the storage type to be associated with the DB cluster.", - "type" : "string" + "EnableGlobalWriteForwarding" : { + "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.", + "type" : "boolean" }, - "KmsKeyId" : { - "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.", - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/Arn" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/KeyId" - } - } ], - "type" : "string" + "EnableHttpEndpoint" : { + "description" : "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.", + "type" : "boolean" }, - "ServerlessV2ScalingConfiguration" : { - "description" : "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.", - "$ref" : "#/definitions/ServerlessV2ScalingConfiguration" + "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" }, - "PerformanceInsightsRetentionPeriod" : { - "description" : "The amount of time, in days, to retain Performance Insights data.", - "type" : "integer" + "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" }, - "DatabaseName" : { - "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.", + "Engine" : { + "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" }, - "DBClusterResourceId" : { - "description" : "The AWS Region-unique, immutable identifier for the DB cluster.", + "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" }, - "AutoMinorVersionUpgrade" : { - "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.", - "type" : "boolean" + "EngineMode" : { + "description" : "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.", + "type" : "string" }, - "DBSubnetGroupName" : { - "description" : "A DB subnet group that you want to associate with this DB cluster.", + "EngineVersion" : { + "description" : "The version number of the database engine to use.", "type" : "string" }, - "DeletionProtection" : { - "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.", + "ManageMasterUserPassword" : { + "description" : "A value that indicates whether to manage the master user password with AWS Secrets Manager.", "type" : "boolean" }, - "AllocatedStorage" : { - "description" : "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.", + "Iops" : { + "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.", "type" : "integer" }, + "KmsKeyId" : { + "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.", + "type" : "string" + }, + "MasterUsername" : { + "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.", + "type" : "string", + "pattern" : "^[a-zA-Z]{1}[a-zA-Z0-9_]*$", + "minLength" : 1 + }, "MasterUserPassword" : { "description" : "The master password for the DB instance.", "type" : "string" }, "MasterUserSecret" : { - "description" : "Contains the secret managed by RDS in AWS Secrets Manager for the master user password.", - "$ref" : "#/definitions/MasterUserSecret" + "$ref" : "#/definitions/MasterUserSecret", + "description" : "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, - "SourceDBClusterIdentifier" : { - "description" : "The identifier of the source DB cluster from which to restore.", - "type" : "string" + "MonitoringInterval" : { + "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.", + "type" : "integer", + "default" : 0 }, - "MasterUsername" : { - "minLength" : 1, - "pattern" : "^[a-zA-Z]{1}[a-zA-Z0-9_]*$", - "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.", + "MonitoringRoleArn" : { + "description" : "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.", "type" : "string" }, - "ScalingConfiguration" : { - "description" : "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.", - "$ref" : "#/definitions/ScalingConfiguration" + "NetworkType" : { + "description" : "The network type of the DB cluster.", + "type" : "string" }, - "ReadEndpoint" : { - "$ref" : "#/definitions/ReadEndpoint" + "PerformanceInsightsEnabled" : { + "description" : "A value that indicates whether to turn on Performance Insights for the DB cluster.", + "type" : "boolean" }, "PerformanceInsightsKmsKeyId" : { "description" : "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.", "type" : "string" }, - "PubliclyAccessible" : { - "description" : "A value that indicates whether the DB cluster is publicly accessible.", - "type" : "boolean" + "PerformanceInsightsRetentionPeriod" : { + "description" : "The amount of time, in days, to retain Performance Insights data.", + "type" : "integer" }, - "Domain" : { - "description" : "The Active Directory directory ID to create the DB cluster in.", - "type" : "string" + "Port" : { + "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.", + "type" : "integer" }, - "BacktrackWindow" : { - "default" : 0, - "description" : "The target backtrack window, in seconds. To disable backtracking, set this value to 0.", - "type" : "integer", - "minimum" : 0 + "PreferredBackupWindow" : { + "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.", + "type" : "string" }, - "DBInstanceParameterGroupName" : { - "description" : "The name of the DB parameter group to apply to all instances of the DB cluster.", + "PreferredMaintenanceWindow" : { + "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.", "type" : "string" }, - "EnableGlobalWriteForwarding" : { - "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.", + "PubliclyAccessible" : { + "description" : "A value that indicates whether the DB cluster is publicly accessible.", "type" : "boolean" }, - "MonitoringRoleArn" : { - "description" : "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.", + "ReplicationSourceIdentifier" : { + "description" : "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.", "type" : "string" }, - "AssociatedRoles" : { - "uniqueItems" : true, - "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.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/DBClusterRole" - } + "RestoreToTime" : { + "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", + "type" : "string" }, - "EnableHttpEndpoint" : { - "description" : "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.", - "type" : "boolean" + "RestoreType" : { + "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.", + "type" : "string", + "default" : "full-copy" + }, + "ServerlessV2ScalingConfiguration" : { + "description" : "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.", + "$ref" : "#/definitions/ServerlessV2ScalingConfiguration" + }, + "ScalingConfiguration" : { + "description" : "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.", + "$ref" : "#/definitions/ScalingConfiguration" }, "SnapshotIdentifier" : { "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.", "type" : "string" }, - "PreferredBackupWindow" : { - "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.", + "SourceDBClusterIdentifier" : { + "description" : "The identifier of the source DB cluster from which to restore.", "type" : "string" }, - "NetworkType" : { - "description" : "The network type of the DB cluster.", + "SourceRegion" : { + "description" : "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.", "type" : "string" }, - "VpcSecurityGroupIds" : { - "uniqueItems" : true, - "description" : "A list of EC2 VPC security groups to associate with this DB cluster.", - "type" : "array", - "items" : { - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::EC2::SecurityGroup", - "propertyPath" : "/properties/GroupId" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::EC2::SecurityGroup", - "propertyPath" : "/properties/Id" - } - } ], - "type" : "string" - } - }, - "CopyTagsToSnapshot" : { - "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.", + "StorageEncrypted" : { + "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" }, - "GlobalClusterIdentifier" : { - "minLength" : 0, - "pattern" : "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "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.", - "type" : "string", - "maxLength" : 63 - }, - "RestoreType" : { - "default" : "full-copy", - "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.", - "type" : "string" + "StorageThroughput" : { + "description" : "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.", + "type" : "integer" }, - "DomainIAMRoleName" : { - "description" : "Specify the name of the IAM role to be used when making API calls to the Directory Service.", + "StorageType" : { + "description" : "Specifies the storage type to be associated with the DB cluster.", "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" + "Tags" : { + "type" : "array", + "maxItems" : 50, + "uniqueItems" : true, + "insertionOrder" : false, + "description" : "An array of key-value pairs to apply to this resource.", + "items" : { + "$ref" : "#/definitions/Tag" + } }, - "DBClusterInstanceClass" : { - "description" : "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.", - "type" : "string" + "UseLatestRestorableTime" : { + "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.", + "type" : "boolean" }, - "AvailabilityZones" : { + "VpcSecurityGroupIds" : { + "description" : "A list of EC2 VPC security groups to associate with this DB cluster.", "uniqueItems" : true, - "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.", - "type" : "array", "items" : { "type" : "string" + }, + "type" : "array" + } + }, + "definitions" : { + "Endpoint" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "Address" : { + "description" : "The connection endpoint for the DB cluster.", + "type" : "string" + }, + "Port" : { + "description" : "The port number that will accept connections on this DB cluster.", + "type" : "string" + } } }, - "DBClusterArn" : { - "description" : "The Amazon Resource Name (ARN) for the DB cluster.", - "type" : "string" - }, - "PreferredMaintenanceWindow" : { - "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.", - "type" : "string" + "ReadEndpoint" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "Address" : { + "description" : "The reader endpoint for the DB cluster.", + "type" : "string" + } + } }, - "Iops" : { - "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.", - "type" : "integer" + "DBClusterRole" : { + "description" : "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "FeatureName" : { + "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.", + "type" : "string" + }, + "RoleArn" : { + "description" : "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.", + "type" : "string" + } + }, + "required" : [ "RoleArn" ] }, - "SourceRegion" : { - "description" : "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.", - "type" : "string" + "ServerlessV2ScalingConfiguration" : { + "description" : "Contains the scaling configuration of an Aurora Serverless v2 DB cluster.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "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.", + "type" : "number" + }, + "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.", + "type" : "number" + } + } }, - "UseLatestRestorableTime" : { - "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.", - "type" : "boolean" + "ScalingConfiguration" : { + "description" : "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "AutoPause" : { + "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).", + "type" : "boolean" + }, + "MaxCapacity" : { + "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.", + "type" : "integer" + }, + "MinCapacity" : { + "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.", + "type" : "integer" + }, + "SecondsBeforeTimeout" : { + "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.", + "type" : "integer" + }, + "SecondsUntilAutoPause" : { + "description" : "The time, in seconds, before an Aurora DB cluster in serverless mode is paused.", + "type" : "integer" + }, + "TimeoutAction" : { + "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" : "string" + } + } }, - "ManageMasterUserPassword" : { - "description" : "A value that indicates whether to manage the master user password with AWS Secrets Manager.", - "type" : "boolean" + "Tag" : { + "description" : "A key-value pair to associate with a resource.", + "type" : "object", + "additionalProperties" : false, + "properties" : { + "Key" : { + "type" : "string", + "description" : "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "minLength" : 1, + "maxLength" : 128 + }, + "Value" : { + "type" : "string", + "description" : "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. ", + "minLength" : 0, + "maxLength" : 256 + } + }, + "required" : [ "Key" ] }, - "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" + "MasterUserSecret" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "SecretArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) of the secret." + }, + "KmsKeyId" : { + "type" : "string", + "description" : "The AWS KMS key identifier that is used to encrypt the secret." + } + } + } + }, + "additionalProperties" : false, + "propertyTransform" : { + "/properties/DBClusterIdentifier" : "$lowercase(DBClusterIdentifier)", + "/properties/DBClusterParameterGroupName" : "$lowercase(DBClusterParameterGroupName)", + "/properties/DBSubnetGroupName" : "$lowercase(DBSubnetGroupName)", + "/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])", + "/properties/MasterUserSecret/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\\/\", MasterUserSecret.KmsKeyId])", + "/properties/NetworkType" : "$lowercase(NetworkType)", + "/properties/PerformanceInsightsKmsKeyId" : "$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\\/\", PerformanceInsightsKmsKeyId])", + "/properties/PreferredMaintenanceWindow" : "$lowercase(PreferredMaintenanceWindow)", + "/properties/SnapshotIdentifier" : "$lowercase(SnapshotIdentifier)", + "/properties/SourceDBClusterIdentifier" : "$lowercase(SourceDBClusterIdentifier)", + "/properties/StorageType" : "$lowercase(StorageType)" + }, + "readOnlyProperties" : [ "/properties/DBClusterArn", "/properties/DBClusterResourceId", "/properties/Endpoint", "/properties/Endpoint/Address", "/properties/Endpoint/Port", "/properties/ReadEndpoint/Port", "/properties/ReadEndpoint/Address", "/properties/MasterUserSecret/SecretArn", "/properties/StorageThroughput" ], + "createOnlyProperties" : [ "/properties/AvailabilityZones", "/properties/DBClusterIdentifier", "/properties/DBSubnetGroupName", "/properties/DBSystemId", "/properties/DatabaseName", "/properties/EngineMode", "/properties/KmsKeyId", "/properties/PubliclyAccessible", "/properties/RestoreToTime", "/properties/RestoreType", "/properties/SnapshotIdentifier", "/properties/SourceDBClusterIdentifier", "/properties/SourceRegion", "/properties/StorageEncrypted", "/properties/UseLatestRestorableTime" ], + "conditionalCreateOnlyProperties" : [ "/properties/Engine", "/properties/GlobalClusterIdentifier", "/properties/MasterUsername" ], + "primaryIdentifier" : [ "/properties/DBClusterIdentifier" ], + "writeOnlyProperties" : [ "/properties/DBInstanceParameterGroupName", "/properties/MasterUserPassword", "/properties/RestoreToTime", "/properties/RestoreType", "/properties/SnapshotIdentifier", "/properties/SourceDBClusterIdentifier", "/properties/SourceRegion", "/properties/UseLatestRestorableTime" ], + "handlers" : { + "create" : { + "permissions" : [ "iam:CreateServiceLinkedRole", "iam:PassRole", "rds:AddRoleToDBCluster", "rds:AddTagsToResource", "rds:CreateDBCluster", "rds:CreateDBInstance", "rds:DescribeDBClusters", "rds:DescribeDBClusterSnapshots", "rds:DescribeDBSnapshots", "rds:DescribeEvents", "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:RestoreDBClusterFromSnapshot", "rds:RestoreDBClusterToPointInTime", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], + "timeoutInMinutes" : 2160 }, - "DBClusterParameterGroupName" : { - "default" : "default.aurora5.6", - "description" : "The name of the DB cluster parameter group to associate with this DB cluster.", - "type" : "string" + "read" : { + "permissions" : [ "rds:DescribeDBClusters" ] }, - "PerformanceInsightsEnabled" : { - "description" : "A value that indicates whether to turn on Performance Insights for the DB cluster.", - "type" : "boolean" + "update" : { + "permissions" : [ "ec2:DescribeSecurityGroups", "iam:PassRole", "rds:AddRoleToDBCluster", "rds:AddTagsToResource", "rds:DescribeDBClusters", "rds:DescribeDBSubnetGroups", "rds:DescribeEvents", "rds:DescribeGlobalClusters", "rds:DisableHttpEndpoint", "rds:EnableHttpEndpoint", "rds:ModifyDBCluster", "rds:ModifyDBInstance", "rds:RemoveFromGlobalCluster", "rds:RemoveRoleFromDBCluster", "rds:RemoveTagsFromResource", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], + "timeoutInMinutes" : 2160 }, - "BackupRetentionPeriod" : { - "default" : 1, - "description" : "The number of days for which automated backups are retained.", - "type" : "integer", - "minimum" : 1 + "delete" : { + "permissions" : [ "rds:CreateDBClusterSnapshot", "rds:DeleteDBCluster", "rds:DeleteDBInstance", "rds:DescribeDBClusters", "rds:DescribeGlobalClusters", "rds:RemoveFromGlobalCluster" ] }, - "EnableCloudwatchLogsExports" : { - "uniqueItems" : true, - "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.", - "type" : "array", - "items" : { - "type" : "string" - } + "list" : { + "permissions" : [ "rds:DescribeDBClusters" ] } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-rds-dbinstance.json b/aws-cloudformation-schema/aws-rds-dbinstance.json index 3d70d7b117..e3ed80a2c8 100644 --- a/aws-cloudformation-schema/aws-rds-dbinstance.json +++ b/aws-cloudformation-schema/aws-rds-dbinstance.json @@ -1,562 +1,521 @@ { - "deprecatedProperties" : [ "/properties/TdeCredentialArn", "/properties/TdeCredentialPassword" ], "typeName" : "AWS::RDS::DBInstance", - "readOnlyProperties" : [ "/properties/Endpoint/Address", "/properties/Endpoint/Port", "/properties/Endpoint/HostedZoneId", "/properties/DbiResourceId", "/properties/DBInstanceArn", "/properties/DBSystemId", "/properties/MasterUserSecret/SecretArn", "/properties/CertificateDetails/CAIdentifier", "/properties/CertificateDetails/ValidTill" ], "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).", - "createOnlyProperties" : [ "/properties/CharacterSetName", "/properties/CustomIAMInstanceProfile", "/properties/DBClusterIdentifier", "/properties/DBInstanceIdentifier", "/properties/DBName", "/properties/DBSubnetGroupName", "/properties/KmsKeyId", "/properties/MasterUsername", "/properties/NcharCharacterSetName", "/properties/Port", "/properties/SourceRegion", "/properties/StorageEncrypted", "/properties/Timezone" ], - "primaryIdentifier" : [ "/properties/DBInstanceIdentifier" ], - "conditionalCreateOnlyProperties" : [ "/properties/AutoMinorVersionUpgrade", "/properties/AvailabilityZone", "/properties/BackupRetentionPeriod", "/properties/DBClusterSnapshotIdentifier", "/properties/DBParameterGroupName", "/properties/DBSnapshotIdentifier", "/properties/Engine", "/properties/MultiAZ", "/properties/PerformanceInsightsKMSKeyId", "/properties/PreferredMaintenanceWindow", "/properties/RestoreTime", "/properties/SourceDBClusterIdentifier", "/properties/SourceDBInstanceAutomatedBackupsArn", "/properties/SourceDBInstanceIdentifier", "/properties/SourceDbiResourceId", "/properties/StorageType", "/properties/UseLatestRestorableTime" ], "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", - "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/StorageType" : "$lowercase(StorageType)", - "/properties/MasterUserSecret/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\\/\", MasterUserSecret.KmsKeyId])", - "/properties/DBClusterIdentifier" : "$lowercase(DBClusterIdentifier)", - "/properties/NetworkType" : "$lowercase(NetworkType)", - "/properties/SourceDBInstanceAutomatedBackupsArn" : "$lowercase(SourceDBInstanceAutomatedBackupsArn)", - "/properties/DBInstanceIdentifier" : "$lowercase(DBInstanceIdentifier)", - "/properties/PerformanceInsightsKMSKeyId" : "$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\\/\", PerformanceInsightsKMSKeyId])", - "/properties/DBParameterGroupName" : "$lowercase(DBParameterGroupName)", - "/properties/DBSubnetGroupName" : "$lowercase(DBSubnetGroupName)", - "/properties/SourceDBInstanceIdentifier" : "$lowercase(SourceDBInstanceIdentifier)", - "/properties/PreferredMaintenanceWindow" : "$lowercase(PreferredMaintenanceWindow)", - "/properties/DBClusterSnapshotIdentifier" : "$lowercase(DBClusterSnapshotIdentifier)", - "/properties/DBName" : "$lowercase(DBName) $OR $uppercase(DBName)", - "/properties/OptionGroupName" : "$lowercase(OptionGroupName)", - "/properties/EngineVersion" : "$join([$string(EngineVersion), \".*\"])", - "/properties/DBSnapshotIdentifier" : "$lowercase(DBSnapshotIdentifier)", - "/properties/Engine" : "$lowercase(Engine)" - }, - "handlers" : { - "read" : { - "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "rds:DescribeDBInstances" ] - }, - "create" : { - "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "iam:CreateServiceLinkedRole", "iam:GetRole", "iam:ListRoles", "iam:PassRole", "kms:CreateGrant", "kms:DescribeKey", "rds:AddRoleToDBInstance", "rds:AddTagsToResource", "rds:CreateDBInstance", "rds:CreateDBInstanceReadReplica", "rds:DescribeDBInstances", "rds:DescribeDBClusters", "rds:DescribeDBClusterSnapshots", "rds:DescribeDBInstanceAutomatedBackups", "rds:DescribeDBSnapshots", "rds:DescribeEvents", "rds:ModifyDBInstance", "rds:RebootDBInstance", "rds:RestoreDBInstanceFromDBSnapshot", "rds:RestoreDBInstanceToPointInTime", "rds:StartDBInstanceAutomatedBackupsReplication", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], - "timeoutInMinutes" : 2160 - }, - "update" : { - "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "iam:CreateServiceLinkedRole", "iam:GetRole", "iam:ListRoles", "iam:PassRole", "kms:CreateGrant", "kms:DescribeKey", "rds:AddRoleToDBInstance", "rds:AddTagsToResource", "rds:DescribeDBClusters", "rds:DescribeDBEngineVersions", "rds:DescribeDBInstances", "rds:DescribeDBParameterGroups", "rds:DescribeEvents", "rds:ModifyDBInstance", "rds:PromoteReadReplica", "rds:RebootDBInstance", "rds:RemoveRoleFromDBInstance", "rds:RemoveTagsFromResource", "rds:StartDBInstanceAutomatedBackupsReplication", "rds:StopDBInstanceAutomatedBackupsReplication", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], - "timeoutInMinutes" : 2160 - }, - "list" : { - "permissions" : [ "rds:DescribeDBInstances" ] - }, - "delete" : { - "permissions" : [ "rds:CreateDBSnapshot", "rds:DeleteDBInstance", "rds:DescribeDBInstances" ], - "timeoutInMinutes" : 2160 - } - }, - "writeOnlyProperties" : [ "/properties/AllowMajorVersionUpgrade", "/properties/AutomaticBackupReplicationKmsKeyId", "/properties/CertificateRotationRestart", "/properties/DBSnapshotIdentifier", "/properties/DeleteAutomatedBackups", "/properties/MasterUserPassword", "/properties/Port", "/properties/RestoreTime", "/properties/SourceDBInstanceAutomatedBackupsArn", "/properties/SourceDBInstanceIdentifier", "/properties/SourceDbiResourceId", "/properties/SourceRegion", "/properties/TdeCredentialPassword", "/properties/UseDefaultProcessorFeatures", "/properties/UseLatestRestorableTime" ], - "additionalProperties" : false, "definitions" : { - "MasterUserSecret" : { - "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.*", - "additionalProperties" : false, + "CertificateDetails" : { "type" : "object", + "additionalProperties" : false, "properties" : { - "SecretArn" : { - "description" : "The Amazon Resource Name (ARN) of the secret.", - "type" : "string" + "CAIdentifier" : { + "type" : "string", + "description" : "The CA identifier of the CA certificate used for the DB instance's server certificate." }, - "KmsKeyId" : { - "description" : "The AWS KMS key identifier that is used to encrypt the secret.", - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/KeyId" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/Arn" - } - } ], - "type" : "string" + "ValidTill" : { + "type" : "string", + "format" : "date-time", + "description" : "The expiration date of the DB instance’s server certificate." } - } + }, + "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*." }, "Endpoint" : { - "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``.", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { "Address" : { - "description" : "Specifies the DNS address of the DB instance.", - "type" : "string" + "type" : "string", + "description" : "Specifies the DNS address of the DB instance." }, "Port" : { - "description" : "Specifies the port that the database engine is listening on.", - "type" : "string" + "type" : "string", + "description" : "Specifies the port that the database engine is listening on." }, "HostedZoneId" : { - "description" : "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.", - "type" : "string" - } - } - }, - "CertificateDetails" : { - "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*.", - "additionalProperties" : false, - "type" : "object", - "properties" : { - "ValidTill" : { - "format" : "date-time", - "description" : "The expiration date of the DB instance’s server certificate.", - "type" : "string" - }, - "CAIdentifier" : { - "description" : "The CA identifier of the CA certificate used for the DB instance's server certificate.", - "type" : "string" + "type" : "string", + "description" : "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." } - } + }, + "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``." }, "DBInstanceRole" : { - "description" : "Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { - "RoleArn" : { - "description" : "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.", - "type" : "string" - }, "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. 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" + "type" : "string", + "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" : "string", + "description" : "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." } }, - "required" : [ "FeatureName", "RoleArn" ] + "required" : [ "FeatureName", "RoleArn" ], + "description" : "Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance." }, "ProcessorFeature" : { - "description" : "The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status.", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { - "Value" : { - "description" : "The value of a processor feature name.", - "type" : "string" - }, "Name" : { - "description" : "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.", "type" : "string", - "enum" : [ "coreCount", "threadsPerCore" ] + "enum" : [ "coreCount", "threadsPerCore" ], + "description" : "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``." + }, + "Value" : { + "type" : "string", + "description" : "The value of a processor feature name." } - } + }, + "description" : "The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status." }, "Tag" : { "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*.", - "additionalProperties" : false, "type" : "object", + "additionalProperties" : false, "properties" : { + "Key" : { + "type" : "string", + "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}_.:/=+\\\\-@]*)$\").", + "minLength" : 1, + "maxLength" : 128 + }, "Value" : { - "minLength" : 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" : "string", + "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}_.:/=+\\\\-@]*)$\").", + "minLength" : 0, "maxLength" : 256 + } + }, + "required" : [ "Key" ] + }, + "MasterUserSecret" : { + "type" : "object", + "additionalProperties" : false, + "properties" : { + "SecretArn" : { + "type" : "string", + "description" : "The Amazon Resource Name (ARN) of the secret." }, - "Key" : { - "minLength" : 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}_.:/=+\\\\-@]*)$\").", + "KmsKeyId" : { "type" : "string", - "maxLength" : 128 + "description" : "The AWS KMS key identifier that is used to encrypt the secret." } }, - "required" : [ "Key" ] + "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" : { - "StorageEncrypted" : { - "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" + "AllocatedStorage" : { + "type" : "string", + "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]*$" }, - "Timezone" : { - "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" + "AllowMajorVersionUpgrade" : { + "type" : "boolean", + "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." }, - "DBSystemId" : { - "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" + "AssociatedRoles" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/DBInstanceRole" + }, + "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" : "boolean", + "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" : "string", + "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*." + }, + "AutomaticBackupReplicationKmsKeyId" : { + "type" : "string", + "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``." + }, + "AvailabilityZone" : { + "type" : "string", + "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" : "integer", + "minimum" : 0, + "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.\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" : "string", + "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" : { - "description" : "The details of the DB instance's server certificate.", - "$ref" : "#/definitions/CertificateDetails" + "$ref" : "#/definitions/CertificateDetails", + "description" : "The details of the DB instance's server certificate." }, - "Port" : { - "pattern" : "^\\d*$", - "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``", - "type" : "string" + "CertificateRotationRestart" : { + "type" : "boolean", + "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." }, - "DBClusterIdentifier" : { - "description" : "The identifier of the DB cluster that the instance will belong to.", - "type" : "string" + "CharacterSetName" : { + "type" : "string", + "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)." }, - "StorageThroughput" : { - "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" + "CopyTagsToSnapshot" : { + "type" : "boolean", + "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." }, - "DbiResourceId" : { - "description" : "", - "type" : "string" + "CustomIAMInstanceProfile" : { + "type" : "string", + "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*." }, - "MonitoringInterval" : { - "default" : 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" + "DBClusterIdentifier" : { + "type" : "string", + "description" : "The identifier of the DB cluster that the instance will belong to." }, - "DBParameterGroupName" : { - "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" + "DBClusterSnapshotIdentifier" : { + "type" : "string", + "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" : { - "description" : "", - "type" : "string" + "type" : "string", + "description" : "" }, - "Endpoint" : { - "description" : "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``.", - "$ref" : "#/definitions/Endpoint" + "DBInstanceClass" : { + "type" : "string", + "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*." }, - "TdeCredentialArn" : { - "description" : "", - "type" : "string" + "DBInstanceIdentifier" : { + "type" : "string", + "pattern" : "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", + "minLength" : 1, + "maxLength" : 63, + "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." }, - "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" + "DbiResourceId" : { + "type" : "string", + "description" : "" }, - "MultiAZ" : { - "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" + "DBName" : { + "type" : "string", + "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." }, - "Engine" : { - "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" + "DBParameterGroupName" : { + "type" : "string", + "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." }, - "Tags" : { - "uniqueItems" : false, - "description" : "An optional array of key-value pairs to apply to this DB instance.", - "insertionOrder" : false, + "DBSecurityGroups" : { "type" : "array", + "uniqueItems" : true, "items" : { - "$ref" : "#/definitions/Tag" - } + "type" : "string" + }, + "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." }, - "PerformanceInsightsKMSKeyId" : { - "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).", - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/Arn" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/KeyId" - } - } ], - "type" : "string" + "DBSnapshotIdentifier" : { + "type" : "string", + "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." }, - "TdeCredentialPassword" : { - "description" : "", - "type" : "string" + "DBSubnetGroupName" : { + "type" : "string", + "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." }, - "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. 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" + "DBSystemId" : { + "type" : "string", + "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." }, - "EngineVersion" : { - "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" + "DedicatedLogVolume" : { + "type" : "boolean", + "description" : "Indicates whether the DB instance has a dedicated log volume (DLV) enabled." }, - "StorageType" : { - "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" + "DeleteAutomatedBackups" : { + "type" : "boolean", + "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." }, - "KmsKeyId" : { - "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.", - "anyOf" : [ { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/KeyId" - } - }, { - "relationshipRef" : { - "typeName" : "AWS::KMS::Key", - "propertyPath" : "/properties/Arn" - } - } ], - "type" : "string" + "DeletionProtection" : { + "type" : "boolean", + "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." }, - "DBInstanceClass" : { - "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" + "Domain" : { + "type" : "string", + "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*." }, - "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.\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" + "DomainAuthSecretArn" : { + "type" : "string", + "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``" }, - "PerformanceInsightsRetentionPeriod" : { - "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" + "DomainDnsIps" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "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``" }, - "AvailabilityZone" : { - "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" + "DomainFqdn" : { + "type" : "string", + "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``" }, - "OptionGroupName" : { - "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" + "DomainIAMRoleName" : { + "type" : "string", + "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" }, - "EnablePerformanceInsights" : { - "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" + "DomainOu" : { + "type" : "string", + "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``" }, - "AutoMinorVersionUpgrade" : { - "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" + "EnableCloudwatchLogsExports" : { + "type" : "array", + "items" : { + "type" : "string" + }, + "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``" }, - "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. \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" + "EnableIAMDatabaseAuthentication" : { + "type" : "boolean", + "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." }, - "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. 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" + "EnablePerformanceInsights" : { + "type" : "boolean", + "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." }, - "DBInstanceIdentifier" : { - "minLength" : 1, - "pattern" : "^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$", - "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.", + "Endpoint" : { + "$ref" : "#/definitions/Endpoint", + "description" : "The connection endpoint for the DB instance.\n The endpoint might not be shown for instances with the status of ``creating``." + }, + "Engine" : { "type" : "string", - "maxLength" : 63 + "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``" }, - "AllocatedStorage" : { - "pattern" : "^[0-9]*$", - "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.", - "type" : "string" + "EngineLifecycleSupport" : { + "type" : "string", + "description" : "" }, - "MasterUserPassword" : { - "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" + "EngineVersion" : { + "type" : "string", + "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.*" }, - "MasterUserSecret" : { - "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.*", - "$ref" : "#/definitions/MasterUserSecret" + "ManageMasterUserPassword" : { + "type" : "boolean", + "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." }, - "NcharCharacterSetName" : { - "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" + "Iops" : { + "type" : "integer", + "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." }, - "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.\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" + "KmsKeyId" : { + "type" : "string", + "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." }, - "DBSecurityGroups" : { - "uniqueItems" : true, - "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.", - "type" : "array", - "items" : { - "relationshipRef" : { - "typeName" : "AWS::RDS::DBSecurityGroup", - "propertyPath" : "/properties/Id" - }, - "type" : "string" - } + "LicenseModel" : { + "type" : "string", + "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." }, "MasterUsername" : { - "minLength" : 1, + "type" : "string", "pattern" : "^[a-zA-Z][a-zA-Z0-9_]{0,127}$", "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.", - "type" : "string", + "minLength" : 1, "maxLength" : 128 }, + "MasterUserPassword" : { + "type" : "string", + "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" : { + "$ref" : "#/definitions/MasterUserSecret", + "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.*" + }, "MaxAllocatedStorage" : { - "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" + "type" : "integer", + "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" }, - "PromotionTier" : { - "default" : 1, - "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``", + "MonitoringInterval" : { "type" : "integer", - "minimum" : 0 + "default" : 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``" }, - "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. \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" + "MonitoringRoleArn" : { + "type" : "string", + "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." }, - "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" + "MultiAZ" : { + "type" : "boolean", + "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." }, - "DomainFqdn" : { - "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" + "NcharCharacterSetName" : { + "type" : "string", + "description" : "The name of the NCHAR character set for the Oracle DB instance.\n This setting doesn't apply to RDS Custom DB instances." }, - "CharacterSetName" : { - "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).", + "NetworkType" : { + "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" }, - "MonitoringRoleArn" : { - "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" + "OptionGroupName" : { + "type" : "string", + "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." }, - "AssociatedRoles" : { - "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.", - "type" : "array", - "items" : { - "$ref" : "#/definitions/DBInstanceRole" - } + "PerformanceInsightsKMSKeyId" : { + "type" : "string", + "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)." }, - "DomainOu" : { - "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" + "PerformanceInsightsRetentionPeriod" : { + "type" : "integer", + "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." }, - "DBClusterSnapshotIdentifier" : { - "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" + "Port" : { + "type" : "string", + "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*$" }, - "SourceDBInstanceAutomatedBackupsArn" : { - "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" + "PreferredBackupWindow" : { + "type" : "string", + "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" : "string", + "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" : { - "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.", "type" : "array", "items" : { "$ref" : "#/definitions/ProcessorFeature" - } - }, - "PreferredBackupWindow" : { - "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" - }, - "RestoreTime" : { - "format" : "date-time", - "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``", - "type" : "string" - }, - "CertificateRotationRestart" : { - "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" - }, - "NetworkType" : { - "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" - }, - "DedicatedLogVolume" : { - "description" : "Indicates whether the DB instance has a dedicated log volume (DLV) enabled.", - "type" : "boolean" + }, + "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." }, - "CopyTagsToSnapshot" : { - "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" + "PromotionTier" : { + "type" : "integer", + "minimum" : 0, + "default" : 1, + "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``" }, - "DomainIAMRoleName" : { - "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" + "PubliclyAccessible" : { + "type" : "boolean", + "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" : { "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" }, - "EngineLifecycleSupport" : { - "description" : "", - "type" : "string" + "RestoreTime" : { + "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``", + "type" : "string", + "format" : "date-time" }, - "LicenseModel" : { - "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.", + "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.\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" }, - "DomainDnsIps" : { - "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``", - "type" : "array", - "items" : { - "type" : "string" - } + "SourceDbiResourceId" : { + "type" : "string", + "description" : "The resource ID of the source DB instance from which to restore." }, - "PreferredMaintenanceWindow" : { - "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" + "SourceDBInstanceAutomatedBackupsArn" : { + "type" : "string", + "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." }, - "Iops" : { - "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" + "SourceDBInstanceIdentifier" : { + "type" : "string", + "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." }, "SourceRegion" : { - "description" : "The ID of the region that contains the source DB instance for the read replica.", - "type" : "string" - }, - "UseLatestRestorableTime" : { - "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" - }, - "CACertificateIdentifier" : { - "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" - }, - "ManageMasterUserPassword" : { - "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" + "type" : "string", + "description" : "The ID of the region that contains the source DB instance for the read replica." }, - "SourceDbiResourceId" : { - "description" : "The resource ID of the source DB instance from which to restore.", - "type" : "string" + "StorageEncrypted" : { + "type" : "boolean", + "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." }, - "DomainAuthSecretArn" : { - "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" + "StorageType" : { + "type" : "string", + "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``." }, - "AutomaticBackupReplicationRegion" : { - "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" + "StorageThroughput" : { + "type" : "integer", + "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." }, - "VPCSecurityGroups" : { - "uniqueItems" : true, - "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.", + "Tags" : { "type" : "array", + "insertionOrder" : false, + "uniqueItems" : false, "items" : { - "relationshipRef" : { - "typeName" : "AWS::EC2::SecurityGroup", - "propertyPath" : "/properties/GroupId" - }, - "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.\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" + "$ref" : "#/definitions/Tag" + }, + "description" : "An optional array of key-value pairs to apply to this DB instance." }, - "DBName" : { - "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" + "TdeCredentialArn" : { + "type" : "string", + "description" : "" }, - "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.\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" + "TdeCredentialPassword" : { + "type" : "string", + "description" : "" }, - "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.\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", - "type" : "integer", - "minimum" : 0 + "Timezone" : { + "type" : "string", + "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)." }, - "CustomIAMInstanceProfile" : { - "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" + "UseDefaultProcessorFeatures" : { + "type" : "boolean", + "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." }, - "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.\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" + "UseLatestRestorableTime" : { + "type" : "boolean", + "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." }, - "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. 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``", + "VPCSecurityGroups" : { "type" : "array", + "uniqueItems" : true, "items" : { "type" : "string" - } + }, + "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." + } + }, + "additionalProperties" : false, + "propertyTransform" : { + "/properties/DBClusterIdentifier" : "$lowercase(DBClusterIdentifier)", + "/properties/DBClusterSnapshotIdentifier" : "$lowercase(DBClusterSnapshotIdentifier)", + "/properties/DBInstanceIdentifier" : "$lowercase(DBInstanceIdentifier)", + "/properties/DBName" : "$lowercase(DBName) $OR $uppercase(DBName)", + "/properties/DBParameterGroupName" : "$lowercase(DBParameterGroupName)", + "/properties/DBSnapshotIdentifier" : "$lowercase(DBSnapshotIdentifier)", + "/properties/DBSubnetGroupName" : "$lowercase(DBSubnetGroupName)", + "/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])", + "/properties/MasterUserSecret/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\\/\", MasterUserSecret.KmsKeyId])", + "/properties/NetworkType" : "$lowercase(NetworkType)", + "/properties/OptionGroupName" : "$lowercase(OptionGroupName)", + "/properties/PerformanceInsightsKMSKeyId" : "$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\\/\", PerformanceInsightsKMSKeyId])", + "/properties/PreferredMaintenanceWindow" : "$lowercase(PreferredMaintenanceWindow)", + "/properties/SourceDBInstanceAutomatedBackupsArn" : "$lowercase(SourceDBInstanceAutomatedBackupsArn)", + "/properties/SourceDBInstanceIdentifier" : "$lowercase(SourceDBInstanceIdentifier)", + "/properties/StorageType" : "$lowercase(StorageType)" + }, + "createOnlyProperties" : [ "/properties/CharacterSetName", "/properties/CustomIAMInstanceProfile", "/properties/DBClusterIdentifier", "/properties/DBInstanceIdentifier", "/properties/DBName", "/properties/DBSubnetGroupName", "/properties/KmsKeyId", "/properties/MasterUsername", "/properties/NcharCharacterSetName", "/properties/Port", "/properties/SourceRegion", "/properties/StorageEncrypted", "/properties/Timezone" ], + "conditionalCreateOnlyProperties" : [ "/properties/AutoMinorVersionUpgrade", "/properties/AvailabilityZone", "/properties/BackupRetentionPeriod", "/properties/DBClusterSnapshotIdentifier", "/properties/DBParameterGroupName", "/properties/DBSnapshotIdentifier", "/properties/Engine", "/properties/MultiAZ", "/properties/PerformanceInsightsKMSKeyId", "/properties/PreferredMaintenanceWindow", "/properties/RestoreTime", "/properties/SourceDBClusterIdentifier", "/properties/SourceDBInstanceAutomatedBackupsArn", "/properties/SourceDBInstanceIdentifier", "/properties/SourceDbiResourceId", "/properties/StorageType", "/properties/UseLatestRestorableTime" ], + "deprecatedProperties" : [ "/properties/TdeCredentialArn", "/properties/TdeCredentialPassword" ], + "writeOnlyProperties" : [ "/properties/AllowMajorVersionUpgrade", "/properties/AutomaticBackupReplicationKmsKeyId", "/properties/CertificateRotationRestart", "/properties/DBSnapshotIdentifier", "/properties/DeleteAutomatedBackups", "/properties/MasterUserPassword", "/properties/Port", "/properties/RestoreTime", "/properties/SourceDBInstanceAutomatedBackupsArn", "/properties/SourceDBInstanceIdentifier", "/properties/SourceDbiResourceId", "/properties/SourceRegion", "/properties/TdeCredentialPassword", "/properties/UseDefaultProcessorFeatures", "/properties/UseLatestRestorableTime" ], + "readOnlyProperties" : [ "/properties/Endpoint/Address", "/properties/Endpoint/Port", "/properties/Endpoint/HostedZoneId", "/properties/DbiResourceId", "/properties/DBInstanceArn", "/properties/DBSystemId", "/properties/MasterUserSecret/SecretArn", "/properties/CertificateDetails/CAIdentifier", "/properties/CertificateDetails/ValidTill" ], + "primaryIdentifier" : [ "/properties/DBInstanceIdentifier" ], + "handlers" : { + "create" : { + "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "iam:CreateServiceLinkedRole", "iam:GetRole", "iam:ListRoles", "iam:PassRole", "kms:CreateGrant", "kms:DescribeKey", "rds:AddRoleToDBInstance", "rds:AddTagsToResource", "rds:CreateDBInstance", "rds:CreateDBInstanceReadReplica", "rds:DescribeDBInstances", "rds:DescribeDBClusters", "rds:DescribeDBClusterSnapshots", "rds:DescribeDBInstanceAutomatedBackups", "rds:DescribeDBSnapshots", "rds:DescribeEvents", "rds:ModifyDBInstance", "rds:RebootDBInstance", "rds:RestoreDBInstanceFromDBSnapshot", "rds:RestoreDBInstanceToPointInTime", "rds:StartDBInstanceAutomatedBackupsReplication", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], + "timeoutInMinutes" : 2160 }, - "UseDefaultProcessorFeatures" : { - "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" + "read" : { + "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "rds:DescribeDBInstances" ] + }, + "update" : { + "permissions" : [ "ec2:DescribeAccountAttributes", "ec2:DescribeAvailabilityZones", "ec2:DescribeInternetGateways", "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcAttribute", "ec2:DescribeVpcs", "iam:CreateServiceLinkedRole", "iam:GetRole", "iam:ListRoles", "iam:PassRole", "kms:CreateGrant", "kms:DescribeKey", "rds:AddRoleToDBInstance", "rds:AddTagsToResource", "rds:DescribeDBClusters", "rds:DescribeDBEngineVersions", "rds:DescribeDBInstances", "rds:DescribeDBParameterGroups", "rds:DescribeEvents", "rds:ModifyDBInstance", "rds:PromoteReadReplica", "rds:RebootDBInstance", "rds:RemoveRoleFromDBInstance", "rds:RemoveTagsFromResource", "rds:StartDBInstanceAutomatedBackupsReplication", "rds:StopDBInstanceAutomatedBackupsReplication", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ], + "timeoutInMinutes" : 2160 + }, + "delete" : { + "permissions" : [ "rds:CreateDBSnapshot", "rds:DeleteDBInstance", "rds:DescribeDBInstances" ], + "timeoutInMinutes" : 2160 + }, + "list" : { + "permissions" : [ "rds:DescribeDBInstances" ] } } } \ No newline at end of file diff --git a/aws-cloudformation-schema/aws-rds-globalcluster.json b/aws-cloudformation-schema/aws-rds-globalcluster.json index 5e65f2c5d8..33df3ac95e 100644 --- a/aws-cloudformation-schema/aws-rds-globalcluster.json +++ b/aws-cloudformation-schema/aws-rds-globalcluster.json @@ -8,6 +8,10 @@ "type" : "string", "enum" : [ "aurora", "aurora-mysql", "aurora-postgresql" ] }, + "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/aws-cloudformation-schema/aws-resiliencehub-app.json b/aws-cloudformation-schema/aws-resiliencehub-app.json index eb48c80af3..af16a38640 100644 --- a/aws-cloudformation-schema/aws-resiliencehub-app.json +++ b/aws-cloudformation-schema/aws-resiliencehub-app.json @@ -204,7 +204,7 @@ "permissions" : [ "cloudformation:DescribeStacks", "cloudformation:ListStackResources", "s3:GetBucketLocation", "s3:GetObject", "s3:ListAllMyBuckets", "autoscaling:DescribeAutoScalingGroups", "apigateway:GET", "ec2:Describe*", "ecs:DescribeServices", "eks:DescribeCluster", "elasticfilesystem:DescribeFileSystems", "elasticloadbalancing:DescribeLoadBalancers", "lambda:GetFunction*", "rds:Describe*", "dynamodb:Describe*", "sqs:GetQueueAttributes", "sns:GetTopicAttributes", "route53:List*", "iam:PassRole", "resiliencehub:*" ] }, "read" : { - "permissions" : [ "resiliencehub:DescribeApp", "resiliencehub:DescribeAppVersionTemplate", "resiliencehub:ListAppVersionResourceMappings", "resiliencehub:ListTagsForResource" ] + "permissions" : [ "resiliencehub:DescribeApp", "resiliencehub:DescribeAppVersionTemplate", "resiliencehub:ListAppVersionResourceMappings", "resiliencehub:ListTagsForResource", "resiliencehub:ListAppVersions" ] }, "update" : { "permissions" : [ "cloudformation:DescribeStacks", "cloudformation:ListStackResources", "s3:GetBucketLocation", "s3:GetObject", "s3:ListAllMyBuckets", "autoscaling:DescribeAutoScalingGroups", "apigateway:GET", "ec2:Describe*", "ecs:DescribeServices", "eks:DescribeCluster", "elasticfilesystem:DescribeFileSystems", "elasticloadbalancing:DescribeLoadBalancers", "lambda:GetFunction*", "rds:Describe*", "dynamodb:Describe*", "sqs:GetQueueAttributes", "sns:GetTopicAttributes", "route53:List*", "iam:PassRole", "resiliencehub:*" ] diff --git a/aws-cloudformation-schema/aws-rolesanywhere-profile.json b/aws-cloudformation-schema/aws-rolesanywhere-profile.json index 0a6def50b1..805d135dd2 100644 --- a/aws-cloudformation-schema/aws-rolesanywhere-profile.json +++ b/aws-cloudformation-schema/aws-rolesanywhere-profile.json @@ -104,6 +104,13 @@ } } }, + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : true, + "cloudFormationSystemTags" : true, + "tagProperty" : "/properties/Tags" + }, "readOnlyProperties" : [ "/properties/ProfileId", "/properties/ProfileArn" ], "primaryIdentifier" : [ "/properties/ProfileId" ], "required" : [ "Name", "RoleArns" ], diff --git a/aws-cloudformation-schema/aws-route53-hostedzone.json b/aws-cloudformation-schema/aws-route53-hostedzone.json index 42822e3cb7..208b1472eb 100644 --- a/aws-cloudformation-schema/aws-route53-hostedzone.json +++ b/aws-cloudformation-schema/aws-route53-hostedzone.json @@ -120,7 +120,7 @@ "readOnlyProperties" : [ "/properties/Id", "/properties/NameServers" ], "primaryIdentifier" : [ "/properties/Id" ], "propertyTransform" : { - "/properties/Name" : "$join([Name, \".\"])" + "/properties/Name" : "Name $OR $join([Name, \".\"])" }, "handlers" : { "create" : { diff --git a/aws-cloudformation-schema/aws-secretsmanager-secret.json b/aws-cloudformation-schema/aws-secretsmanager-secret.json index 00b8516cfb..1244462cff 100644 --- a/aws-cloudformation-schema/aws-secretsmanager-secret.json +++ b/aws-cloudformation-schema/aws-secretsmanager-secret.json @@ -142,7 +142,7 @@ "writeOnlyProperties" : [ "/properties/SecretString", "/properties/GenerateSecretString" ], "handlers" : { "create" : { - "permissions" : [ "secretsmanager:DescribeSecret", "secretsmanager:GetRandomPassword", "secretsmanager:CreateSecret", "secretsmanager:TagResource" ] + "permissions" : [ "secretsmanager:DescribeSecret", "secretsmanager:GetRandomPassword", "secretsmanager:CreateSecret", "secretsmanager:TagResource", "secretsmanager:ReplicateSecretToRegions" ] }, "delete" : { "permissions" : [ "secretsmanager:DeleteSecret", "secretsmanager:DescribeSecret", "secretsmanager:RemoveRegionsFromReplication" ] diff --git a/aws-cloudformation-schema/aws-ses-configurationset.json b/aws-cloudformation-schema/aws-ses-configurationset.json index 0de8c92bd6..f91e1514d3 100644 --- a/aws-cloudformation-schema/aws-ses-configurationset.json +++ b/aws-cloudformation-schema/aws-ses-configurationset.json @@ -12,7 +12,8 @@ "type" : "string", "description" : "The domain to use for tracking open and click events." } - } + }, + "required" : [ "CustomRedirectDomain" ] }, "DeliveryOptions" : { "description" : "An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.", diff --git a/aws-cloudformation-schema/aws-ses-configurationseteventdestination.json b/aws-cloudformation-schema/aws-ses-configurationseteventdestination.json index 55bbbb67c4..ec7c6e0c7b 100644 --- a/aws-cloudformation-schema/aws-ses-configurationseteventdestination.json +++ b/aws-cloudformation-schema/aws-ses-configurationseteventdestination.json @@ -36,10 +36,28 @@ "SnsDestination" : { "description" : "An object that contains SNS topic ARN associated event destination.", "$ref" : "#/definitions/SnsDestination" + }, + "EventBridgeDestination" : { + "description" : "An object that contains Event bus ARN associated with the event bridge destination.", + "$ref" : "#/definitions/EventBridgeDestination" } }, "required" : [ "MatchingEventTypes" ] }, + "EventBridgeDestination" : { + "type" : "object", + "additionalProperties" : false, + "description" : "An object that contains Event bus ARN associated with the event bridge destination.", + "properties" : { + "EventBusArn" : { + "type" : "string", + "minLength" : 36, + "maxLength" : 1024, + "pattern" : "^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:\\d{12}:event-bus/[^:]+$" + } + }, + "required" : [ "EventBusArn" ] + }, "SnsDestination" : { "type" : "object", "additionalProperties" : false, diff --git a/aws-cloudformation-schema/aws-signer-profilepermission.json b/aws-cloudformation-schema/aws-signer-profilepermission.json index 995443ba46..8133173b1c 100644 --- a/aws-cloudformation-schema/aws-signer-profilepermission.json +++ b/aws-cloudformation-schema/aws-signer-profilepermission.json @@ -4,7 +4,8 @@ "sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git", "properties" : { "ProfileName" : { - "type" : "string" + "type" : "string", + "pattern" : "^[0-9a-zA-Z_]{2,64}$" }, "ProfileVersion" : { "type" : "string", diff --git a/aws-cloudformation-schema/aws-signer-signingprofile.json b/aws-cloudformation-schema/aws-signer-signingprofile.json index a1d98ac69e..00ba2aeed6 100644 --- a/aws-cloudformation-schema/aws-signer-signingprofile.json +++ b/aws-cloudformation-schema/aws-signer-signingprofile.json @@ -11,6 +11,12 @@ "type" : "string", "pattern" : "^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$" }, + "ProfileName" : { + "type" : "string", + "minLength" : 2, + "maxLength" : 64, + "pattern" : "^[0-9a-zA-Z_]$" + }, "ProfileVersion" : { "type" : "string", "pattern" : "^[0-9a-zA-Z]{10}$" @@ -48,8 +54,8 @@ }, "properties" : { "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" + "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. ", + "$ref" : "#/definitions/ProfileName" }, "ProfileVersion" : { "description" : "A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name.", @@ -81,7 +87,7 @@ }, "additionalProperties" : false, "required" : [ "PlatformId" ], - "createOnlyProperties" : [ "/properties/PlatformId", "/properties/SignatureValidityPeriod" ], + "createOnlyProperties" : [ "/properties/ProfileName", "/properties/PlatformId", "/properties/SignatureValidityPeriod" ], "readOnlyProperties" : [ "/properties/ProfileName", "/properties/ProfileVersion", "/properties/Arn", "/properties/ProfileVersionArn" ], "primaryIdentifier" : [ "/properties/Arn" ], "additionalIdentifiers" : [ [ "/properties/ProfileName" ], [ "/properties/ProfileVersionArn" ] ], diff --git a/aws-cloudformation-schema/aws-verifiedpermissions-identitysource.json b/aws-cloudformation-schema/aws-verifiedpermissions-identitysource.json index a5e938b8ca..a7d9c1e897 100644 --- a/aws-cloudformation-schema/aws-verifiedpermissions-identitysource.json +++ b/aws-cloudformation-schema/aws-verifiedpermissions-identitysource.json @@ -54,6 +54,16 @@ }, "required" : [ "CognitoUserPoolConfiguration" ], "additionalProperties" : false + }, { + "type" : "object", + "title" : "OpenIdConnectConfiguration", + "properties" : { + "OpenIdConnectConfiguration" : { + "$ref" : "#/definitions/OpenIdConnectConfiguration" + } + }, + "required" : [ "OpenIdConnectConfiguration" ], + "additionalProperties" : false } ] }, "IdentitySourceDetails" : { @@ -89,6 +99,115 @@ }, "additionalProperties" : false }, + "OpenIdConnectAccessTokenConfiguration" : { + "type" : "object", + "properties" : { + "PrincipalIdClaim" : { + "type" : "string", + "default" : "sub", + "minLength" : 1 + }, + "Audiences" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 255, + "minLength" : 1 + }, + "maxItems" : 255, + "minItems" : 1, + "insertionOrder" : false + } + }, + "additionalProperties" : false + }, + "OpenIdConnectConfiguration" : { + "type" : "object", + "properties" : { + "Issuer" : { + "type" : "string", + "maxLength" : 2048, + "minLength" : 1, + "pattern" : "^https://.*$" + }, + "EntityIdPrefix" : { + "type" : "string", + "maxLength" : 100, + "minLength" : 1 + }, + "GroupConfiguration" : { + "$ref" : "#/definitions/OpenIdConnectGroupConfiguration" + }, + "TokenSelection" : { + "$ref" : "#/definitions/OpenIdConnectTokenSelection" + } + }, + "required" : [ "Issuer", "TokenSelection" ], + "additionalProperties" : false + }, + "OpenIdConnectGroupConfiguration" : { + "type" : "object", + "properties" : { + "GroupClaim" : { + "type" : "string", + "minLength" : 1 + }, + "GroupEntityType" : { + "type" : "string", + "maxLength" : 200, + "minLength" : 1, + "pattern" : "^([_a-zA-Z][_a-zA-Z0-9]*::)*[_a-zA-Z][_a-zA-Z0-9]*$" + } + }, + "required" : [ "GroupClaim", "GroupEntityType" ], + "additionalProperties" : false + }, + "OpenIdConnectIdentityTokenConfiguration" : { + "type" : "object", + "properties" : { + "PrincipalIdClaim" : { + "type" : "string", + "default" : "sub", + "minLength" : 1 + }, + "ClientIds" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 255, + "minLength" : 1, + "pattern" : "^.*$" + }, + "maxItems" : 1000, + "minItems" : 0, + "insertionOrder" : false + } + }, + "additionalProperties" : false + }, + "OpenIdConnectTokenSelection" : { + "oneOf" : [ { + "type" : "object", + "title" : "AccessTokenOnly", + "properties" : { + "AccessTokenOnly" : { + "$ref" : "#/definitions/OpenIdConnectAccessTokenConfiguration" + } + }, + "required" : [ "AccessTokenOnly" ], + "additionalProperties" : false + }, { + "type" : "object", + "title" : "IdentityTokenOnly", + "properties" : { + "IdentityTokenOnly" : { + "$ref" : "#/definitions/OpenIdConnectIdentityTokenConfiguration" + } + }, + "required" : [ "IdentityTokenOnly" ], + "additionalProperties" : false + } ] + }, "OpenIdIssuer" : { "type" : "string", "enum" : [ "COGNITO" ] diff --git a/aws-cloudformation-schema/aws-workspaces-workspacespool.json b/aws-cloudformation-schema/aws-workspaces-workspacespool.json new file mode 100644 index 0000000000..1910cf46d2 --- /dev/null +++ b/aws-cloudformation-schema/aws-workspaces-workspacespool.json @@ -0,0 +1,152 @@ +{ + "typeName" : "AWS::WorkSpaces::WorkspacesPool", + "description" : "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", + "definitions" : { + "Tag" : { + "type" : "object", + "properties" : { + "Key" : { + "type" : "string" + }, + "Value" : { + "type" : "string" + } + }, + "required" : [ "Key", "Value" ], + "additionalProperties" : false + }, + "ApplicationSettingsStatus" : { + "type" : "string", + "enum" : [ "DISABLED", "ENABLED" ] + }, + "Capacity" : { + "type" : "object", + "properties" : { + "DesiredUserSessions" : { + "type" : "integer", + "minimum" : 0 + } + }, + "required" : [ "DesiredUserSessions" ], + "additionalProperties" : false + }, + "ApplicationSettings" : { + "type" : "object", + "properties" : { + "Status" : { + "$ref" : "#/definitions/ApplicationSettingsStatus" + }, + "SettingsGroup" : { + "type" : "string", + "pattern" : "^[A-Za-z0-9_./()!*'-]+$", + "maxLength" : 100 + } + }, + "required" : [ "Status" ], + "additionalProperties" : false + }, + "TimeoutSettings" : { + "type" : "object", + "properties" : { + "DisconnectTimeoutInSeconds" : { + "type" : "integer", + "minimum" : 60, + "maximum" : 36000 + }, + "IdleDisconnectTimeoutInSeconds" : { + "type" : "integer", + "minimum" : 0, + "maximum" : 36000 + }, + "MaxUserDurationInSeconds" : { + "type" : "integer", + "minimum" : 600, + "maximum" : 432000 + } + }, + "required" : [ ], + "additionalProperties" : false + } + }, + "properties" : { + "PoolId" : { + "type" : "string", + "pattern" : "^wspool-[0-9a-z]{9}$" + }, + "PoolArn" : { + "type" : "string", + "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}$" + }, + "Capacity" : { + "$ref" : "#/definitions/Capacity" + }, + "PoolName" : { + "type" : "string", + "pattern" : "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" + }, + "Description" : { + "type" : "string", + "pattern" : "^[a-zA-Z0-9_./() -]+$", + "minLength" : 1, + "maxLength" : 255 + }, + "CreatedAt" : { + "type" : "string" + }, + "BundleId" : { + "type" : "string", + "pattern" : "^wsb-[0-9a-z]{8,63}$" + }, + "DirectoryId" : { + "type" : "string", + "pattern" : "^wsd-[0-9a-z]{8,63}$", + "minLength" : 10, + "maxLength" : 65 + }, + "ApplicationSettings" : { + "$ref" : "#/definitions/ApplicationSettings" + }, + "TimeoutSettings" : { + "$ref" : "#/definitions/TimeoutSettings" + }, + "Tags" : { + "type" : "array", + "uniqueItems" : false, + "insertionOrder" : false, + "items" : { + "$ref" : "#/definitions/Tag" + } + } + }, + "required" : [ "PoolName", "BundleId", "DirectoryId", "Capacity" ], + "additionalProperties" : false, + "tagging" : { + "taggable" : true, + "tagOnCreate" : true, + "tagUpdatable" : false, + "cloudFormationSystemTags" : false, + "tagProperty" : "/properties/Tags" + }, + "primaryIdentifier" : [ "/properties/PoolId" ], + "createOnlyProperties" : [ "/properties/PoolName" ], + "readOnlyProperties" : [ "/properties/PoolId", "/properties/PoolArn", "/properties/CreatedAt" ], + "writeOnlyProperties" : [ "/properties/Tags" ], + "deprecatedProperties" : [ "/properties/Tags/TagKey", "/properties/Tags/TagValue" ], + "handlers" : { + "create" : { + "permissions" : [ "workspaces:CreateWorkspacesPool", "workspaces:DescribeWorkspacesPools", "workspaces:CreateTags" ] + }, + "read" : { + "permissions" : [ "workspaces:DescribeWorkspacesPools" ] + }, + "update" : { + "permissions" : [ "workspaces:UpdateWorkspacesPool" ] + }, + "delete" : { + "permissions" : [ "workspaces:DescribeWorkspacesPools", "workspaces:TerminateWorkspacesPool" ] + }, + "list" : { + "permissions" : [ "workspaces:DescribeWorkspacesPools" ] + } + } +} \ No newline at end of file diff --git a/provider/cmd/pulumi-gen-aws-native/supported-types.txt b/provider/cmd/pulumi-gen-aws-native/supported-types.txt index 40199caa36..125a1c89e0 100644 --- a/provider/cmd/pulumi-gen-aws-native/supported-types.txt +++ b/provider/cmd/pulumi-gen-aws-native/supported-types.txt @@ -995,6 +995,7 @@ AWS::Wisdom::Assistant AWS::Wisdom::AssistantAssociation AWS::Wisdom::KnowledgeBase AWS::WorkSpaces::ConnectionAlias +AWS::WorkSpaces::WorkspacesPool AWS::WorkSpacesThinClient::Environment AWS::WorkSpacesWeb::BrowserSettings AWS::WorkSpacesWeb::IdentityProvider diff --git a/provider/cmd/pulumi-resource-aws-native/metadata.json b/provider/cmd/pulumi-resource-aws-native/metadata.json index 2aec3f5c3f..655a6867c0 100644 --- a/provider/cmd/pulumi-resource-aws-native/metadata.json +++ b/provider/cmd/pulumi-resource-aws-native/metadata.json @@ -14914,11 +14914,6 @@ "minLength": 1, "maxLength": 255 }, - "required": [ - "firehoseArn", - "outputFormat", - "roleArn" - ], "createOnly": [ "name" ], @@ -18389,77 +18384,77 @@ "inputs": { "description": { "type": "string", - "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." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } }, "outputs": { "description": { "type": "string", - "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." }, "evaluationFormArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) for the evaluation form." + "description": "The Amazon Resource Name (ARN) of the evaluation form." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } }, "required": [ @@ -25964,10 +25959,6 @@ "$ref": "#/types/aws-native:dms:ReplicationConfigComputeConfig", "description": "Configuration parameters for provisioning an AWS DMS Serverless replication." }, - "replicationConfigArn": { - "type": "string", - "description": "The Amazon Resource Name (ARN) of the Replication Config" - }, "replicationConfigIdentifier": { "type": "string", "description": "A unique identifier of replication configuration" @@ -35541,6 +35532,10 @@ "$ref": "#/types/aws-native:eks:ClusterAccessConfig", "description": "The access configuration for the cluster." }, + "bootstrapSelfManagedAddons": { + "type": "boolean", + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created." + }, "encryptionConfig": { "type": "array", "items": { @@ -35597,6 +35592,11 @@ "type": "string", "description": "The unique ID given to your cluster." }, + "bootstrapSelfManagedAddons": { + "type": "boolean", + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created.", + "replaceOnChanges": true + }, "certificateAuthorityData": { "type": "string", "description": "The certificate-authority-data for your cluster." @@ -35676,6 +35676,7 @@ ], "createOnly": [ "accessConfig/BootstrapClusterCreatorAdminPermissions", + "bootstrapSelfManagedAddons", "encryptionConfig", "kubernetesNetworkConfig", "name", @@ -35683,7 +35684,8 @@ "roleArn" ], "writeOnly": [ - "accessConfig/BootstrapClusterCreatorAdminPermissions" + "accessConfig/BootstrapClusterCreatorAdminPermissions", + "bootstrapSelfManagedAddons" ], "irreversibleNames": { "awsId": "Id" @@ -43979,6 +43981,7 @@ "maxLength": 64 }, "required": [ + "detectorId", "findingCriteria" ], "createOnly": [ @@ -44080,15 +44083,15 @@ "inputs": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "tags": { "type": "array", @@ -44101,7 +44104,7 @@ "outputs": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "arn": { "type": "string", @@ -44117,22 +44120,22 @@ }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "status": { "type": "string", - "description": "Malware Protection plan status." + "description": "Status of the Malware Protection plan resource." }, "statusReasons": { "type": "array", "items": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnStatusReasons" }, - "description": "Information about the issue code and message associated to the status of your Malware Protection plan." + "description": "Status details associated with the Malware Protection plan resource status." }, "tags": { "type": "array", @@ -54725,7 +54728,7 @@ }, "runtime": { "type": "string", - "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + "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": { "$ref": "#/types/aws-native:lambda:FunctionRuntimeManagementConfig", @@ -54844,7 +54847,7 @@ }, "runtime": { "type": "string", - "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + "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": { "$ref": "#/types/aws-native:lambda:FunctionRuntimeManagementConfig", @@ -71432,6 +71435,10 @@ "type": "boolean", "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": "boolean", + "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." + }, "engine": { "type": "string", "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" @@ -71686,6 +71693,10 @@ "type": "boolean", "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": "boolean", + "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": { "$ref": "#/types/aws-native:rds:DbClusterEndpoint" }, @@ -73308,6 +73319,10 @@ "$ref": "#/types/aws-native:rds:GlobalClusterEngine", "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": "string", + "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": "string", "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." @@ -73335,6 +73350,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).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", "replaceOnChanges": true }, + "engineLifecycleSupport": { + "type": "string", + "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": "string", "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." @@ -84552,6 +84571,10 @@ "$ref": "#/types/aws-native:signer:SigningProfilePlatformId", "description": "The ID of the target signing platform." }, + "profileName": { + "type": "string", + "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. " + }, "signatureValidityPeriod": { "$ref": "#/types/aws-native:signer:SigningProfileSignatureValidityPeriod", "description": "Signature validity period of the profile." @@ -84576,7 +84599,8 @@ }, "profileName": { "type": "string", - "description": "A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " + "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. ", + "replaceOnChanges": true }, "profileVersion": { "type": "string", @@ -84599,11 +84623,15 @@ "description": "A list of tags associated with the signing profile." } }, + "autoNamingSpec": { + "sdkName": "profileName" + }, "required": [ "platformId" ], "createOnly": [ "platformId", + "profileName", "signatureValidityPeriod" ], "tagsProperty": "tags", @@ -88466,7 +88494,14 @@ "cf": "AWS::VerifiedPermissions::IdentitySource", "inputs": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "policyStoreId": { @@ -88480,7 +88515,14 @@ }, "outputs": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "details": { @@ -90420,6 +90462,93 @@ "tagsProperty": "tags", "tagsStyle": "keyValueArrayCreateOnly" }, + "aws-native:workspaces:WorkspacesPool": { + "cf": "AWS::WorkSpaces::WorkspacesPool", + "inputs": { + "applicationSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettings" + }, + "bundleId": { + "type": "string" + }, + "capacity": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolCapacity" + }, + "description": { + "type": "string" + }, + "directoryId": { + "type": "string" + }, + "poolName": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + } + }, + "timeoutSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolTimeoutSettings" + } + }, + "outputs": { + "applicationSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettings" + }, + "bundleId": { + "type": "string" + }, + "capacity": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolCapacity" + }, + "createdAt": { + "type": "string" + }, + "description": { + "type": "string" + }, + "directoryId": { + "type": "string" + }, + "poolArn": { + "type": "string" + }, + "poolId": { + "type": "string" + }, + "poolName": { + "type": "string", + "replaceOnChanges": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + } + }, + "timeoutSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolTimeoutSettings" + } + }, + "autoNamingSpec": { + "sdkName": "poolName" + }, + "required": [ + "bundleId", + "capacity", + "directoryId" + ], + "createOnly": [ + "poolName" + ], + "writeOnly": [ + "tags" + ], + "tagsProperty": "tags", + "tagsStyle": "keyValueArray" + }, "aws-native:workspacesthinclient:Environment": { "cf": "AWS::WorkSpacesThinClient::Environment", "inputs": { @@ -106897,7 +107026,7 @@ "properties": { "section": { "$ref": "#/types/aws-native:connect:EvaluationFormSection", - "description": "The evaluation form section item" + "description": "A subsection or inner section of an item." } } }, @@ -106906,11 +107035,11 @@ "properties": { "question": { "$ref": "#/types/aws-native:connect:EvaluationFormQuestion", - "description": "The evaluation form question item" + "description": "The information of the question." }, "section": { "$ref": "#/types/aws-native:connect:EvaluationFormSection", - "description": "The evaluation form section item" + "description": "The information of the section." } } }, @@ -106919,7 +107048,7 @@ "properties": { "propertyValue": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomation", - "description": "The automation property name of the question." + "description": "The property value of the automation." } } }, @@ -106928,19 +107057,19 @@ "properties": { "automaticFail": { "type": "boolean", - "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." }, "maxValue": { "type": "integer", - "description": "The maximum value of the option range." + "description": "The maximum answer value of the range option." }, "minValue": { "type": "integer", - "description": "The minimum value of the option range." + "description": "The minimum answer value of the range option." }, "score": { "type": "integer", - "description": "The score of the option range." + "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" } } }, @@ -106949,22 +107078,22 @@ "properties": { "automation": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionAutomation", - "description": "The automation properties for the numeric question." + "description": "The automation properties of the numeric question." }, "maxValue": { "type": "integer", - "description": "The maximum value for answers of the question." + "description": "The maximum answer value." }, "minValue": { "type": "integer", - "description": "The minimum value for answers of the question." + "description": "The minimum answer value." }, "options": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionOption" }, - "description": "The list of option ranges used for scoring." + "description": "The scoring options of the numeric question." } } }, @@ -106973,7 +107102,7 @@ "properties": { "label": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomationLabel", - "description": "The automation property label." + "description": "The property label of the automation." } } }, @@ -106985,7 +107114,7 @@ "properties": { "instructions": { "type": "string", - "description": "The instructions for the question." + "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024." }, "notApplicableEnabled": { "type": "boolean", @@ -106993,23 +107122,23 @@ }, "questionType": { "$ref": "#/types/aws-native:connect:EvaluationFormQuestionQuestionType", - "description": "The type of the question." + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``" }, "questionTypeProperties": { "$ref": "#/types/aws-native:connect: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": { "type": "string", - "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": { "type": "string", - "description": "The title of the question." + "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350." }, "weight": { "type": "number", - "description": "The question weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" } } }, @@ -107025,7 +107154,7 @@ }, "singleSelect": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionProperties", - "description": "The properties of the single-select question." + "description": "The properties of the numeric question." } } }, @@ -107034,11 +107163,11 @@ "properties": { "mode": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategyMode", - "description": "The scoring mode." + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``" }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategyStatus", - "description": "The scoring status." + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``" } } }, @@ -107053,26 +107182,26 @@ "properties": { "instructions": { "type": "string", - "description": "The instructions for the section." + "description": "The instructions of the section." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormItem" }, - "description": "The list of section items." + "description": "The items of the section.\n *Minimum*: 1" }, "refId": { "type": "string", - "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": { "type": "string", - "description": "The title of the section." + "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." }, "weight": { "type": "number", - "description": "The item weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" } } }, @@ -107081,14 +107210,14 @@ "properties": { "defaultOptionRefId": { "type": "string", - "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": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomationOption" }, - "description": "The answer options for the automation." + "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20" } } }, @@ -107097,7 +107226,7 @@ "properties": { "ruleCategory": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomation", - "description": "The automation option based on Rules categories." + "description": "The automation option based on a rule category for the single select question." } } }, @@ -107106,19 +107235,19 @@ "properties": { "automaticFail": { "type": "boolean", - "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." }, "refId": { "type": "string", - "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": { "type": "integer", - "description": "The score of the option." + "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" }, "text": { "type": "string", - "description": "The title of the option." + "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." } } }, @@ -107127,18 +107256,18 @@ "properties": { "automation": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomation", - "description": "The automation properties for the single-select question." + "description": "The display mode of the single select question." }, "displayAs": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionPropertiesDisplayAs", - "description": "The display mode of the single-select question." + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``" }, "options": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionOption" }, - "description": "The list of options for the question." + "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256" } } }, @@ -107150,15 +107279,15 @@ "properties": { "category": { "type": "string", - "description": "The category name as defined in Rules." + "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50" }, "condition": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition", - "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" }, "optionRefId": { "type": "string", - "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." } } }, @@ -107173,11 +107302,11 @@ "properties": { "key": { "type": "string", - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters 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 -" }, "value": { "type": "string", - "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 -" } } }, @@ -119304,11 +119433,11 @@ "properties": { "type": { "type": "string", - "description": "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." + "description": "The type of resource to assign to a container." }, "value": { "type": "string", - "description": "The value for the specified resource type.\n If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." + "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." } } }, @@ -121606,6 +121735,10 @@ "type": "string", "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" }, + "diskType": { + "type": "string", + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" + }, "memory": { "type": "string", "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." @@ -126340,7 +126473,7 @@ "properties": { "tagging": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnTagging", - "description": "Indicates whether the scanned S3 object will have tags about the scan result." + "description": "Contains information about tagging status of the Malware Protection plan resource." } } }, @@ -126377,7 +126510,7 @@ "properties": { "code": { "type": "string", - "description": "Issue code." + "description": "The status code of the Malware Protection plan." }, "message": { "type": "string", @@ -126390,7 +126523,7 @@ "properties": { "status": { "type": "string", - "description": "Indicates whether or not the tags will added." + "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object." } } }, @@ -135639,6 +135772,10 @@ "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationSnapshotConfiguration", "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." }, + "applicationSystemRollbackConfiguration": { + "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + }, "environmentProperties": { "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationEnvironmentProperties", "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." @@ -136111,6 +136248,15 @@ } } }, + "aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration": { + "type": "object", + "properties": { + "rollbackEnabled": { + "type": "boolean", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + } + } + }, "aws-native:kinesisanalyticsv2:ApplicationTag": { "type": "object", "properties": { @@ -194542,6 +194688,14 @@ } } }, + "aws-native:ses:ConfigurationSetEventDestinationEventBridgeDestination": { + "type": "object", + "properties": { + "eventBusArn": { + "type": "string" + } + } + }, "aws-native:ses:ConfigurationSetEventDestinationEventDestination": { "type": "object", "properties": { @@ -194553,6 +194707,10 @@ "type": "boolean", "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": { + "$ref": "#/types/aws-native:ses:ConfigurationSetEventDestinationEventBridgeDestination", + "description": "An object that contains Event bus ARN associated with the event bridge destination." + }, "kinesisFirehoseDestination": { "$ref": "#/types/aws-native:ses:ConfigurationSetEventDestinationKinesisFirehoseDestination", "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." @@ -197011,11 +197169,11 @@ } } }, - "aws-native:verifiedpermissions:IdentitySourceConfigurationProperties": { + "aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties": { "type": "object", "properties": { - "cognitoUserPoolConfiguration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceCognitoUserPoolConfiguration" + "openIdConnectConfiguration": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectConfiguration" } } }, @@ -197039,6 +197197,85 @@ } } }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectAccessTokenConfiguration": { + "type": "object", + "properties": { + "audiences": { + "type": "array", + "items": { + "type": "string" + } + }, + "principalIdClaim": { + "type": "string" + } + } + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectConfiguration": { + "type": "object", + "properties": { + "entityIdPrefix": { + "type": "string" + }, + "groupConfiguration": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectGroupConfiguration" + }, + "issuer": { + "type": "string" + }, + "tokenSelection": { + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection1Properties" + } + ] + } + } + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectGroupConfiguration": { + "type": "object", + "properties": { + "groupClaim": { + "type": "string" + }, + "groupEntityType": { + "type": "string" + } + } + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectIdentityTokenConfiguration": { + "type": "object", + "properties": { + "clientIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "principalIdClaim": { + "type": "string" + } + } + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection0Properties": { + "type": "object", + "properties": { + "accessTokenOnly": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectAccessTokenConfiguration" + } + } + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection1Properties": { + "type": "object", + "properties": { + "identityTokenOnly": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectIdentityTokenConfiguration" + } + } + }, "aws-native:verifiedpermissions:IdentitySourceOpenIdIssuer": { "type": "string" }, @@ -200275,6 +200512,53 @@ } } }, + "aws-native:workspaces:WorkspacesPoolApplicationSettings": { + "type": "object", + "properties": { + "settingsGroup": { + "type": "string" + }, + "status": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettingsStatus" + } + } + }, + "aws-native:workspaces:WorkspacesPoolApplicationSettingsStatus": { + "type": "string" + }, + "aws-native:workspaces:WorkspacesPoolCapacity": { + "type": "object", + "properties": { + "desiredUserSessions": { + "type": "integer" + } + } + }, + "aws-native:workspaces:WorkspacesPoolTag": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "aws-native:workspaces:WorkspacesPoolTimeoutSettings": { + "type": "object", + "properties": { + "disconnectTimeoutInSeconds": { + "type": "integer" + }, + "idleDisconnectTimeoutInSeconds": { + "type": "integer" + }, + "maxUserDurationInSeconds": { + "type": "integer" + } + } + }, "aws-native:workspacesthinclient:EnvironmentDayOfWeek": { "type": "string" }, @@ -206616,6 +206900,12 @@ "aliasId" ] }, + "aws-native:workspaces:getWorkspacesPool": { + "cf": "AWS::WorkSpaces::WorkspacesPool", + "ids": [ + "poolId" + ] + }, "aws-native:workspacesthinclient:getEnvironment": { "cf": "AWS::WorkSpacesThinClient::Environment", "ids": [ diff --git a/provider/cmd/pulumi-resource-aws-native/schema.json b/provider/cmd/pulumi-resource-aws-native/schema.json index 9effcfc8e7..f807526fac 100644 --- a/provider/cmd/pulumi-resource-aws-native/schema.json +++ b/provider/cmd/pulumi-resource-aws-native/schema.json @@ -22841,11 +22841,11 @@ ] }, "aws-native:connect:EvaluationFormBaseItem": { - "description": "The evaluation form base item.", + "description": "An item at the root level. All items must be sections.", "properties": { "section": { "$ref": "#/types/aws-native:connect:EvaluationFormSection", - "description": "The evaluation form section item" + "description": "A subsection or inner section of an item." } }, "type": "object", @@ -22854,25 +22854,25 @@ ] }, "aws-native:connect:EvaluationFormItem": { - "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": "#/types/aws-native:connect:EvaluationFormQuestion", - "description": "The evaluation form question item" + "description": "The information of the question." }, "section": { "$ref": "#/types/aws-native:connect:EvaluationFormSection", - "description": "The evaluation form section item" + "description": "The information of the section." } }, "type": "object" }, "aws-native:connect:EvaluationFormNumericQuestionAutomation": { - "description": "The automation properties for the numeric question.", + "description": "Information about the automation configuration in numeric questions.", "properties": { "propertyValue": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomation", - "description": "The automation property name of the question." + "description": "The property value of the automation." } }, "type": "object", @@ -22881,23 +22881,23 @@ ] }, "aws-native:connect:EvaluationFormNumericQuestionOption": { - "description": "The option ranges used for scoring in numeric questions.", + "description": "Information about the option range used for scoring in numeric questions.", "properties": { "automaticFail": { "type": "boolean", - "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." }, "maxValue": { "type": "integer", - "description": "The maximum value of the option range." + "description": "The maximum answer value of the range option." }, "minValue": { "type": "integer", - "description": "The minimum value of the option range." + "description": "The minimum answer value of the range option." }, "score": { "type": "integer", - "description": "The score of the option range." + "description": "The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10" } }, "type": "object", @@ -22907,26 +22907,26 @@ ] }, "aws-native:connect:EvaluationFormNumericQuestionProperties": { - "description": "The properties of the numeric question.", + "description": "Information about properties for a numeric question in an evaluation form.", "properties": { "automation": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionAutomation", - "description": "The automation properties for the numeric question." + "description": "The automation properties of the numeric question." }, "maxValue": { "type": "integer", - "description": "The maximum value for answers of the question." + "description": "The maximum answer value." }, "minValue": { "type": "integer", - "description": "The minimum value for answers of the question." + "description": "The minimum answer value." }, "options": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionOption" }, - "description": "The list of option ranges used for scoring." + "description": "The scoring options of the numeric question." } }, "type": "object", @@ -22936,11 +22936,11 @@ ] }, "aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomation": { - "description": "The automation property name of the question.", + "description": "Information about the property value used in automation of a numeric questions.", "properties": { "label": { "$ref": "#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomationLabel", - "description": "The automation property label." + "description": "The property label of the automation." } }, "type": "object", @@ -22949,7 +22949,7 @@ ] }, "aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomationLabel": { - "description": "The automation property label.", + "description": "The property label of the automation.", "type": "string", "enum": [ { @@ -22987,11 +22987,11 @@ ] }, "aws-native:connect:EvaluationFormQuestion": { - "description": "The evaluation form question.", + "description": "Information about a question from an evaluation form.", "properties": { "instructions": { "type": "string", - "description": "The instructions for the question." + "description": "The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024." }, "notApplicableEnabled": { "type": "boolean", @@ -22999,23 +22999,23 @@ }, "questionType": { "$ref": "#/types/aws-native:connect:EvaluationFormQuestionQuestionType", - "description": "The type of the question." + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``" }, "questionTypeProperties": { "$ref": "#/types/aws-native:connect: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": { "type": "string", - "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": { "type": "string", - "description": "The title of the question." + "description": "The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350." }, "weight": { "type": "number", - "description": "The question weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100" } }, "type": "object", @@ -23026,7 +23026,7 @@ ] }, "aws-native:connect:EvaluationFormQuestionQuestionType": { - "description": "The type of the question.", + "description": "The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``", "type": "string", "enum": [ { @@ -23044,7 +23044,7 @@ ] }, "aws-native:connect:EvaluationFormQuestionTypeProperties": { - "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": "#/types/aws-native:connect:EvaluationFormNumericQuestionProperties", @@ -23052,21 +23052,21 @@ }, "singleSelect": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionProperties", - "description": "The properties of the single-select question." + "description": "The properties of the numeric question." } }, "type": "object" }, "aws-native:connect:EvaluationFormScoringStrategy": { - "description": "The scoring strategy.", + "description": "A scoring strategy of the evaluation form.", "properties": { "mode": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategyMode", - "description": "The scoring mode." + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``" }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategyStatus", - "description": "The scoring status." + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``" } }, "type": "object", @@ -23076,7 +23076,7 @@ ] }, "aws-native:connect:EvaluationFormScoringStrategyMode": { - "description": "The scoring mode.", + "description": "The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``", "type": "string", "enum": [ { @@ -23090,7 +23090,7 @@ ] }, "aws-native:connect:EvaluationFormScoringStrategyStatus": { - "description": "The scoring status.", + "description": "The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``", "type": "string", "enum": [ { @@ -23104,30 +23104,30 @@ ] }, "aws-native:connect:EvaluationFormSection": { - "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": { "type": "string", - "description": "The instructions for the section." + "description": "The instructions of the section." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormItem" }, - "description": "The list of section items." + "description": "The items of the section.\n *Minimum*: 1" }, "refId": { "type": "string", - "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": { "type": "string", - "description": "The title of the section." + "description": "The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." }, "weight": { "type": "number", - "description": "The item weight used for scoring." + "description": "The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100" } }, "type": "object", @@ -23137,18 +23137,18 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionAutomation": { - "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": { "type": "string", - "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": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomationOption" }, - "description": "The answer options for the automation." + "description": "The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20" } }, "type": "object", @@ -23157,11 +23157,11 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionAutomationOption": { - "description": "The automation option for the single-select question.", + "description": "The automation options of the single select question.", "properties": { "ruleCategory": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomation", - "description": "The automation option based on Rules categories." + "description": "The automation option based on a rule category for the single select question." } }, "type": "object", @@ -23170,23 +23170,23 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionOption": { - "description": "The option for a question.", + "description": "Information about the automation configuration in single select questions.", "properties": { "automaticFail": { "type": "boolean", - "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." }, "refId": { "type": "string", - "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": { "type": "integer", - "description": "The score of the option." + "description": "The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10" }, "text": { "type": "string", - "description": "The title of the option." + "description": "The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128." } }, "type": "object", @@ -23196,22 +23196,22 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionProperties": { - "description": "The properties of the single-select question.", + "description": "Information about the options in single select questions.", "properties": { "automation": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomation", - "description": "The automation properties for the single-select question." + "description": "The display mode of the single select question." }, "displayAs": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionPropertiesDisplayAs", - "description": "The display mode of the single-select question." + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``" }, "options": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionOption" }, - "description": "The list of options for the question." + "description": "The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256" } }, "type": "object", @@ -23220,7 +23220,7 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionPropertiesDisplayAs": { - "description": "The display mode of the single-select question.", + "description": "The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``", "type": "string", "enum": [ { @@ -23234,19 +23234,19 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomation": { - "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": { "type": "string", - "description": "The category name as defined in Rules." + "description": "The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50" }, "condition": { "$ref": "#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition", - "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" }, "optionRefId": { "type": "string", - "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." } }, "type": "object", @@ -23257,7 +23257,7 @@ ] }, "aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition": { - "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", "type": "string", "enum": [ { @@ -23271,7 +23271,7 @@ ] }, "aws-native:connect:EvaluationFormStatus": { - "description": "The status of the evaluation form.", + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``", "type": "string", "enum": [ { @@ -23289,11 +23289,11 @@ "properties": { "key": { "type": "string", - "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters 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 -" }, "value": { "type": "string", - "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 -" } }, "type": "object", @@ -41046,11 +41046,11 @@ "properties": { "type": { "type": "string", - "description": "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." + "description": "The type of resource to assign to a container." }, "value": { "type": "string", - "description": "The value for the specified resource type.\n If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." + "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": "object", @@ -43882,6 +43882,10 @@ "type": "string", "description": "Per worker Disk resource. GB is the only supported unit and specifying GB is optional" }, + "diskType": { + "type": "string", + "description": "Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional" + }, "memory": { "type": "string", "description": "Per worker memory resource. GB is the only supported unit and specifying GB is optional." @@ -51071,7 +51075,7 @@ "properties": { "tagging": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnTagging", - "description": "Indicates whether the scanned S3 object will have tags about the scan result." + "description": "Contains information about tagging status of the Malware Protection plan resource." } }, "type": "object" @@ -51109,7 +51113,7 @@ "properties": { "code": { "type": "string", - "description": "Issue code." + "description": "The status code of the Malware Protection plan." }, "message": { "type": "string", @@ -51122,7 +51126,7 @@ "properties": { "status": { "type": "string", - "description": "Indicates whether or not the tags will added." + "description": "Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object." } }, "type": "object" @@ -64138,6 +64142,10 @@ "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationSnapshotConfiguration", "description": "Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application." }, + "applicationSystemRollbackConfiguration": { + "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + }, "environmentProperties": { "$ref": "#/types/aws-native:kinesisanalyticsv2:ApplicationEnvironmentProperties", "description": "Describes execution properties for a Flink-based Kinesis Data Analytics application." @@ -64788,6 +64796,19 @@ }, "type": "object" }, + "aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration": { + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.", + "properties": { + "rollbackEnabled": { + "type": "boolean", + "description": "Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application." + } + }, + "type": "object", + "required": [ + "rollbackEnabled" + ] + }, "aws-native:kinesisanalyticsv2:ApplicationTag": { "description": "A key-value pair that identifies an application.", "properties": { @@ -144548,6 +144569,18 @@ "dimensionValueSource" ] }, + "aws-native:ses:ConfigurationSetEventDestinationEventBridgeDestination": { + "description": "An object that contains Event bus ARN associated with the event bridge destination.", + "properties": { + "eventBusArn": { + "type": "string" + } + }, + "type": "object", + "required": [ + "eventBusArn" + ] + }, "aws-native:ses:ConfigurationSetEventDestinationEventDestination": { "properties": { "cloudWatchDestination": { @@ -144558,6 +144591,10 @@ "type": "boolean", "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": { + "$ref": "#/types/aws-native:ses:ConfigurationSetEventDestinationEventBridgeDestination", + "description": "An object that contains Event bus ARN associated with the event bridge destination." + }, "kinesisFirehoseDestination": { "$ref": "#/types/aws-native:ses:ConfigurationSetEventDestinationKinesisFirehoseDestination", "description": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination." @@ -144668,7 +144705,10 @@ "description": "The domain to use for tracking open and click events." } }, - "type": "object" + "type": "object", + "required": [ + "customRedirectDomain" + ] }, "aws-native:ses:ConfigurationSetVdmOptions": { "description": "An object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.", @@ -148532,15 +148572,15 @@ "cognitoUserPoolConfiguration" ] }, - "aws-native:verifiedpermissions:IdentitySourceConfigurationProperties": { + "aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties": { "properties": { - "cognitoUserPoolConfiguration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceCognitoUserPoolConfiguration" + "openIdConnectConfiguration": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectConfiguration" } }, "type": "object", "required": [ - "cognitoUserPoolConfiguration" + "openIdConnectConfiguration" ] }, "aws-native:verifiedpermissions:IdentitySourceDetails": { @@ -148563,6 +148603,99 @@ }, "type": "object" }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectAccessTokenConfiguration": { + "properties": { + "audiences": { + "type": "array", + "items": { + "type": "string" + } + }, + "principalIdClaim": { + "type": "string" + } + }, + "type": "object" + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectConfiguration": { + "properties": { + "entityIdPrefix": { + "type": "string" + }, + "groupConfiguration": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectGroupConfiguration" + }, + "issuer": { + "type": "string" + }, + "tokenSelection": { + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection1Properties" + } + ] + } + }, + "type": "object", + "required": [ + "issuer", + "tokenSelection" + ] + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectGroupConfiguration": { + "properties": { + "groupClaim": { + "type": "string" + }, + "groupEntityType": { + "type": "string" + } + }, + "type": "object", + "required": [ + "groupClaim", + "groupEntityType" + ] + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectIdentityTokenConfiguration": { + "properties": { + "clientIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "principalIdClaim": { + "type": "string" + } + }, + "type": "object" + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection0Properties": { + "properties": { + "accessTokenOnly": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectAccessTokenConfiguration" + } + }, + "type": "object", + "required": [ + "accessTokenOnly" + ] + }, + "aws-native:verifiedpermissions:IdentitySourceOpenIdConnectTokenSelection1Properties": { + "properties": { + "identityTokenOnly": { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceOpenIdConnectIdentityTokenConfiguration" + } + }, + "type": "object", + "required": [ + "identityTokenOnly" + ] + }, "aws-native:verifiedpermissions:IdentitySourceOpenIdIssuer": { "type": "string", "enum": [ @@ -153446,6 +153579,73 @@ "value" ] }, + "aws-native:workspaces:WorkspacesPoolApplicationSettings": { + "properties": { + "settingsGroup": { + "type": "string" + }, + "status": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettingsStatus" + } + }, + "type": "object", + "required": [ + "status" + ] + }, + "aws-native:workspaces:WorkspacesPoolApplicationSettingsStatus": { + "type": "string", + "enum": [ + { + "name": "Disabled", + "value": "DISABLED" + }, + { + "name": "Enabled", + "value": "ENABLED" + } + ] + }, + "aws-native:workspaces:WorkspacesPoolCapacity": { + "properties": { + "desiredUserSessions": { + "type": "integer" + } + }, + "type": "object", + "required": [ + "desiredUserSessions" + ] + }, + "aws-native:workspaces:WorkspacesPoolTag": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object", + "required": [ + "key", + "value" + ] + }, + "aws-native:workspaces:WorkspacesPoolTimeoutSettings": { + "properties": { + "disconnectTimeoutInSeconds": { + "type": "integer" + }, + "idleDisconnectTimeoutInSeconds": { + "type": "integer" + }, + "maxUserDurationInSeconds": { + "type": "integer" + } + }, + "type": "object" + }, "aws-native:workspacesthinclient:EnvironmentDayOfWeek": { "type": "string", "enum": [ @@ -168748,10 +168948,7 @@ "required": [ "arn", "creationDate", - "firehoseArn", "lastUpdateDate", - "outputFormat", - "roleArn", "state" ], "inputProperties": { @@ -168803,12 +169000,7 @@ }, "description": "A set of tags to assign to the delivery stream." } - }, - "requiredInputs": [ - "firehoseArn", - "outputFormat", - "roleArn" - ] + } }, "aws-native:codeartifact:Domain": { "description": "The resource schema to create a CodeArtifact domain.\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n EncryptionKey = \"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n PermissionsPolicyDocument = new Dictionary\u003cstring, object?\u003e\n {\n [\"version\"] = \"2012-10-17\",\n [\"statement\"] = new[]\n {\n new Dictionary\u003cstring, object?\u003e\n {\n [\"action\"] = new[]\n {\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n },\n [\"effect\"] = \"Allow\",\n [\"principal\"] = new Dictionary\u003cstring, object?\u003e\n {\n [\"aws\"] = \"arn:aws:iam::123456789012:root\",\n },\n [\"resource\"] = \"*\",\n },\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t\tEncryptionKey: pulumi.String(\"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\"),\n\t\t\tPermissionsPolicyDocument: pulumi.Any(map[string]interface{}{\n\t\t\t\t\"version\": \"2012-10-17\",\n\t\t\t\t\"statement\": []map[string]interface{}{\n\t\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\t\"action\": []string{\n\t\t\t\t\t\t\t\"codeartifact:ReadFromRepository\",\n\t\t\t\t\t\t\t\"codeartifact:DescribePackageVersion\",\n\t\t\t\t\t\t\t\"codeartifact:DescribeRepository\",\n\t\t\t\t\t\t\t\"codeartifact:GetPackageVersionReadme\",\n\t\t\t\t\t\t\t\"codeartifact:GetRepositoryEndpoint\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersionAssets\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersionDependencies\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersions\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackages\",\n\t\t\t\t\t\t\t\"codeartifact:ReadFromRepository\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"effect\": \"Allow\",\n\t\t\t\t\t\t\"principal\": map[string]interface{}{\n\t\t\t\t\t\t\t\"aws\": \"arn:aws:iam::123456789012:root\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"resource\": \"*\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t}),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {\n domainName: \"my-domain\",\n encryptionKey: \"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n permissionsPolicyDocument: {\n version: \"2012-10-17\",\n statement: [{\n action: [\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n ],\n effect: \"Allow\",\n principal: {\n aws: \"arn:aws:iam::123456789012:root\",\n },\n resource: \"*\",\n }],\n },\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\",\n domain_name=\"my-domain\",\n encryption_key=\"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n permissions_policy_document={\n \"version\": \"2012-10-17\",\n \"statement\": [{\n \"action\": [\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n ],\n \"effect\": \"Allow\",\n \"principal\": {\n \"aws\": \"arn:aws:iam::123456789012:root\",\n },\n \"resource\": \"*\",\n }],\n })\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n EncryptionKey = \"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n PermissionsPolicyDocument = new Dictionary\u003cstring, object?\u003e\n {\n [\"version\"] = \"2012-10-17\",\n [\"statement\"] = new[]\n {\n new Dictionary\u003cstring, object?\u003e\n {\n [\"action\"] = new[]\n {\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n },\n [\"effect\"] = \"Allow\",\n [\"principal\"] = new Dictionary\u003cstring, object?\u003e\n {\n [\"aws\"] = \"arn:aws:iam::123456789012:root\",\n },\n [\"resource\"] = \"*\",\n },\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t\tEncryptionKey: pulumi.String(\"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\"),\n\t\t\tPermissionsPolicyDocument: pulumi.Any(map[string]interface{}{\n\t\t\t\t\"version\": \"2012-10-17\",\n\t\t\t\t\"statement\": []map[string]interface{}{\n\t\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\t\"action\": []string{\n\t\t\t\t\t\t\t\"codeartifact:ReadFromRepository\",\n\t\t\t\t\t\t\t\"codeartifact:DescribePackageVersion\",\n\t\t\t\t\t\t\t\"codeartifact:DescribeRepository\",\n\t\t\t\t\t\t\t\"codeartifact:GetPackageVersionReadme\",\n\t\t\t\t\t\t\t\"codeartifact:GetRepositoryEndpoint\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersionAssets\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersionDependencies\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackageVersions\",\n\t\t\t\t\t\t\t\"codeartifact:ListPackages\",\n\t\t\t\t\t\t\t\"codeartifact:ReadFromRepository\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"effect\": \"Allow\",\n\t\t\t\t\t\t\"principal\": map[string]interface{}{\n\t\t\t\t\t\t\t\"aws\": \"arn:aws:iam::123456789012:root\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"resource\": \"*\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t}),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {\n domainName: \"my-domain\",\n encryptionKey: \"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n permissionsPolicyDocument: {\n version: \"2012-10-17\",\n statement: [{\n action: [\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n ],\n effect: \"Allow\",\n principal: {\n aws: \"arn:aws:iam::123456789012:root\",\n },\n resource: \"*\",\n }],\n },\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\",\n domain_name=\"my-domain\",\n encryption_key=\"arn:aws:kms:us-west-2:123456789012:key/12345678-9abc-def1-2345-6789abcdef12\",\n permissions_policy_document={\n \"version\": \"2012-10-17\",\n \"statement\": [{\n \"action\": [\n \"codeartifact:ReadFromRepository\",\n \"codeartifact:DescribePackageVersion\",\n \"codeartifact:DescribeRepository\",\n \"codeartifact:GetPackageVersionReadme\",\n \"codeartifact:GetRepositoryEndpoint\",\n \"codeartifact:ListPackageVersionAssets\",\n \"codeartifact:ListPackageVersionDependencies\",\n \"codeartifact:ListPackageVersions\",\n \"codeartifact:ListPackages\",\n \"codeartifact:ReadFromRepository\",\n ],\n \"effect\": \"Allow\",\n \"principal\": {\n \"aws\": \"arn:aws:iam::123456789012:root\",\n },\n \"resource\": \"*\",\n }],\n })\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname1\",\n Value = \"value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {\n domainName: \"my-domain\",\n tags: [\n {\n key: \"keyname1\",\n value: \"value1\",\n },\n {\n key: \"keyname2\",\n value: \"value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\",\n domain_name=\"my-domain\",\n tags=[\n aws_native.TagArgs(\n key=\"keyname1\",\n value=\"value1\",\n ),\n aws_native.TagArgs(\n key=\"keyname2\",\n value=\"value2\",\n ),\n ])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname1\",\n Value = \"value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {\n domainName: \"my-domain\",\n tags: [\n {\n key: \"keyname1\",\n value: \"value1\",\n },\n {\n key: \"keyname2\",\n value: \"value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\",\n domain_name=\"my-domain\",\n tags=[\n aws_native.TagArgs(\n key=\"keyname1\",\n value=\"value1\",\n ),\n aws_native.TagArgs(\n key=\"keyname2\",\n value=\"value2\",\n ),\n ])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name)\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name)\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactUpstreamRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactUpstreamRepository\", new()\n {\n RepositoryName = \"my-upstream-repo\",\n DomainName = myCodeArtifactDomain.Name,\n ExternalConnections = new[]\n {\n \"public:npmjs\",\n },\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n Upstreams = new[]\n {\n myCodeArtifactUpstreamRepository.Name,\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyCodeArtifactUpstreamRepository, err := codeartifact.NewRepository(ctx, \"myCodeArtifactUpstreamRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-upstream-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tExternalConnections: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"public:npmjs\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tUpstreams: pulumi.StringArray{\n\t\t\t\tmyCodeArtifactUpstreamRepository.Name,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactUpstreamRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactUpstreamRepository\", {\n repositoryName: \"my-upstream-repo\",\n domainName: myCodeArtifactDomain.name,\n externalConnections: [\"public:npmjs\"],\n});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n upstreams: [myCodeArtifactUpstreamRepository.name],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_upstream_repository = aws_native.codeartifact.Repository(\"myCodeArtifactUpstreamRepository\",\n repository_name=\"my-upstream-repo\",\n domain_name=my_code_artifact_domain.name,\n external_connections=[\"public:npmjs\"])\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name,\n upstreams=[my_code_artifact_upstream_repository.name])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactUpstreamRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactUpstreamRepository\", new()\n {\n RepositoryName = \"my-upstream-repo\",\n DomainName = myCodeArtifactDomain.Name,\n ExternalConnections = new[]\n {\n \"public:npmjs\",\n },\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n Upstreams = new[]\n {\n myCodeArtifactUpstreamRepository.Name,\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyCodeArtifactUpstreamRepository, err := codeartifact.NewRepository(ctx, \"myCodeArtifactUpstreamRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-upstream-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tExternalConnections: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"public:npmjs\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tUpstreams: pulumi.StringArray{\n\t\t\t\tmyCodeArtifactUpstreamRepository.Name,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactUpstreamRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactUpstreamRepository\", {\n repositoryName: \"my-upstream-repo\",\n domainName: myCodeArtifactDomain.name,\n externalConnections: [\"public:npmjs\"],\n});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n upstreams: [myCodeArtifactUpstreamRepository.name],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_upstream_repository = aws_native.codeartifact.Repository(\"myCodeArtifactUpstreamRepository\",\n repository_name=\"my-upstream-repo\",\n domain_name=my_code_artifact_domain.name,\n external_connections=[\"public:npmjs\"])\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name,\n upstreams=[my_code_artifact_upstream_repository.name])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname1\",\n Value = \"value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n tags: [\n {\n key: \"keyname1\",\n value: \"value1\",\n },\n {\n key: \"keyname2\",\n value: \"value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name,\n tags=[\n aws_native.TagArgs(\n key=\"keyname1\",\n value=\"value1\",\n ),\n aws_native.TagArgs(\n key=\"keyname2\",\n value=\"value2\",\n ),\n ])\n\n```\n\n{{% /example %}}\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCodeArtifactDomain = new AwsNative.CodeArtifact.Domain(\"myCodeArtifactDomain\", new()\n {\n DomainName = \"my-domain\",\n });\n\n var myCodeArtifactRepository = new AwsNative.CodeArtifact.Repository(\"myCodeArtifactRepository\", new()\n {\n RepositoryName = \"my-repo\",\n DomainName = myCodeArtifactDomain.Name,\n Tags = new[]\n {\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname1\",\n Value = \"value1\",\n },\n new AwsNative.Inputs.TagArgs\n {\n Key = \"keyname2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\tawsnative \"github.com/pulumi/pulumi-aws-native/sdk/go/aws\"\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/codeartifact\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyCodeArtifactDomain, err := codeartifact.NewDomain(ctx, \"myCodeArtifactDomain\", \u0026codeartifact.DomainArgs{\n\t\t\tDomainName: pulumi.String(\"my-domain\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = codeartifact.NewRepository(ctx, \"myCodeArtifactRepository\", \u0026codeartifact.RepositoryArgs{\n\t\t\tRepositoryName: pulumi.String(\"my-repo\"),\n\t\t\tDomainName: myCodeArtifactDomain.Name,\n\t\t\tTags: aws.TagArray{\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026aws.TagArgs{\n\t\t\t\t\tKey: pulumi.String(\"keyname2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst myCodeArtifactDomain = new aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", {domainName: \"my-domain\"});\nconst myCodeArtifactRepository = new aws_native.codeartifact.Repository(\"myCodeArtifactRepository\", {\n repositoryName: \"my-repo\",\n domainName: myCodeArtifactDomain.name,\n tags: [\n {\n key: \"keyname1\",\n value: \"value1\",\n },\n {\n key: \"keyname2\",\n value: \"value2\",\n },\n ],\n});\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nmy_code_artifact_domain = aws_native.codeartifact.Domain(\"myCodeArtifactDomain\", domain_name=\"my-domain\")\nmy_code_artifact_repository = aws_native.codeartifact.Repository(\"myCodeArtifactRepository\",\n repository_name=\"my-repo\",\n domain_name=my_code_artifact_domain.name,\n tags=[\n aws_native.TagArgs(\n key=\"keyname1\",\n value=\"value1\",\n ),\n aws_native.TagArgs(\n key=\"keyname2\",\n value=\"value2\",\n ),\n ])\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n", @@ -172106,45 +172298,45 @@ ] }, "aws-native:connect:EvaluationForm": { - "description": "Resource Type definition for AWS::Connect::EvaluationForm", + "description": "Creates an evaluation form for the specified CON instance.", "properties": { "description": { "type": "string", - "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." }, "evaluationFormArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) for the evaluation form." + "description": "The Amazon Resource Name (ARN) of the evaluation form." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } }, "type": "object", @@ -172158,37 +172350,37 @@ "inputProperties": { "description": { "type": "string", - "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." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } }, "requiredInputs": [ @@ -179596,15 +179788,14 @@ } }, "type": "object", + "required": [ + "replicationConfigArn" + ], "inputProperties": { "computeConfig": { "$ref": "#/types/aws-native:dms:ReplicationConfigComputeConfig", "description": "Configuration parameters for provisioning an AWS DMS Serverless replication." }, - "replicationConfigArn": { - "type": "string", - "description": "The Amazon Resource Name (ARN) of the Replication Config" - }, "replicationConfigIdentifier": { "type": "string", "description": "A unique identifier of replication configuration" @@ -188909,6 +189100,11 @@ "type": "string", "description": "The unique ID given to your cluster." }, + "bootstrapSelfManagedAddons": { + "type": "boolean", + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created.", + "replaceOnChanges": true + }, "certificateAuthorityData": { "type": "string", "description": "The certificate-authority-data for your cluster." @@ -188994,6 +189190,10 @@ "$ref": "#/types/aws-native:eks:ClusterAccessConfig", "description": "The access configuration for the cluster." }, + "bootstrapSelfManagedAddons": { + "type": "boolean", + "description": "Set this value to false to avoid creating the default networking addons when the cluster is created." + }, "encryptionConfig": { "type": "array", "items": { @@ -197040,7 +197240,9 @@ }, "type": "object", "required": [ - "findingCriteria" + "detectorId", + "findingCriteria", + "name" ], "inputProperties": { "action": { @@ -197076,6 +197278,7 @@ } }, "requiredInputs": [ + "detectorId", "findingCriteria" ] }, @@ -197160,7 +197363,7 @@ "properties": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "arn": { "type": "string", @@ -197176,22 +197379,22 @@ }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "status": { "type": "string", - "description": "Malware Protection plan status." + "description": "Status of the Malware Protection plan resource." }, "statusReasons": { "type": "array", "items": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnStatusReasons" }, - "description": "Information about the issue code and message associated to the status of your Malware Protection plan." + "description": "Status details associated with the Malware Protection plan resource status." }, "tags": { "type": "array", @@ -197214,15 +197417,15 @@ "inputProperties": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "tags": { "type": "array", @@ -207395,7 +207598,7 @@ }, "runtime": { "type": "string", - "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + "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": { "$ref": "#/types/aws-native:lambda:FunctionRuntimeManagementConfig", @@ -207519,7 +207722,7 @@ }, "runtime": { "type": "string", - "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + "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": { "$ref": "#/types/aws-native:lambda:FunctionRuntimeManagementConfig", @@ -223654,6 +223857,10 @@ "type": "boolean", "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": "boolean", + "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": { "$ref": "#/types/aws-native:rds:DbClusterEndpoint" }, @@ -223919,6 +224126,10 @@ "type": "boolean", "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": "boolean", + "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." + }, "engine": { "type": "string", "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" @@ -225386,6 +225597,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).\nIf you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the cluster.", "replaceOnChanges": true }, + "engineLifecycleSupport": { + "type": "string", + "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": "string", "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." @@ -225416,6 +225631,10 @@ "$ref": "#/types/aws-native:rds:GlobalClusterEngine", "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": "string", + "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": "string", "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." @@ -236218,7 +236437,8 @@ }, "profileName": { "type": "string", - "description": "A name for the signing profile. AWS CloudFormation generates a unique physical ID and uses that ID for the signing profile name. " + "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. ", + "replaceOnChanges": true }, "profileVersion": { "type": "string", @@ -236254,6 +236474,10 @@ "$ref": "#/types/aws-native:signer:SigningProfilePlatformId", "description": "The ID of the target signing platform." }, + "profileName": { + "type": "string", + "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. " + }, "signatureValidityPeriod": { "$ref": "#/types/aws-native:signer:SigningProfileSignatureValidityPeriod", "description": "Signature validity period of the profile." @@ -239979,10 +240203,17 @@ ] }, "aws-native:verifiedpermissions:IdentitySource": { - "description": "Definition of AWS::VerifiedPermissions::IdentitySource Resource Type\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var policyStoreId = config.Require(\"policyStoreId\");\n var userPoolArn = config.Require(\"userPoolArn\");\n var clientIds = config.RequireObject\u003cstring[]\u003e(\"clientIds\");\n var principalEntityType = config.Require(\"principalEntityType\");\n var identitySource = new AwsNative.VerifiedPermissions.IdentitySource(\"identitySource\", new()\n {\n PolicyStoreId = policyStoreId,\n Configuration = new AwsNative.VerifiedPermissions.Inputs.IdentitySourceConfigurationPropertiesArgs\n {\n CognitoUserPoolConfiguration = new AwsNative.VerifiedPermissions.Inputs.IdentitySourceCognitoUserPoolConfigurationArgs\n {\n UserPoolArn = userPoolArn,\n ClientIds = clientIds,\n },\n },\n PrincipalEntityType = principalEntityType,\n });\n\n return new Dictionary\u003cstring, object?\u003e\n {\n [\"identitySourceId\"] = identitySource.IdentitySourceId,\n };\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/verifiedpermissions\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tpolicyStoreId := cfg.Require(\"policyStoreId\")\n\t\tuserPoolArn := cfg.Require(\"userPoolArn\")\n\t\tclientIds := cfg.Require(\"clientIds\")\n\t\tprincipalEntityType := cfg.Require(\"principalEntityType\")\n\t\tidentitySource, err := verifiedpermissions.NewIdentitySource(ctx, \"identitySource\", \u0026verifiedpermissions.IdentitySourceArgs{\n\t\t\tPolicyStoreId: pulumi.String(policyStoreId),\n\t\t\tConfiguration: \u0026verifiedpermissions.IdentitySourceConfigurationPropertiesArgs{\n\t\t\t\tCognitoUserPoolConfiguration: \u0026verifiedpermissions.IdentitySourceCognitoUserPoolConfigurationArgs{\n\t\t\t\t\tUserPoolArn: pulumi.String(userPoolArn),\n\t\t\t\t\tClientIds: clientIds,\n\t\t\t\t},\n\t\t\t},\n\t\t\tPrincipalEntityType: pulumi.String(principalEntityType),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tctx.Export(\"identitySourceId\", identitySource.IdentitySourceId)\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst config = new pulumi.Config();\nconst policyStoreId = config.require(\"policyStoreId\");\nconst userPoolArn = config.require(\"userPoolArn\");\nconst clientIds = config.requireObject\u003cArray\u003cstring\u003e\u003e(\"clientIds\");\nconst principalEntityType = config.require(\"principalEntityType\");\nconst identitySource = new aws_native.verifiedpermissions.IdentitySource(\"identitySource\", {\n policyStoreId: policyStoreId,\n configuration: {\n cognitoUserPoolConfiguration: {\n userPoolArn: userPoolArn,\n clientIds: clientIds,\n },\n },\n principalEntityType: principalEntityType,\n});\nexport const identitySourceId = identitySource.identitySourceId;\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nconfig = pulumi.Config()\npolicy_store_id = config.require(\"policyStoreId\")\nuser_pool_arn = config.require(\"userPoolArn\")\nclient_ids = config.require_object(\"clientIds\")\nprincipal_entity_type = config.require(\"principalEntityType\")\nidentity_source = aws_native.verifiedpermissions.IdentitySource(\"identitySource\",\n policy_store_id=policy_store_id,\n configuration=aws_native.verifiedpermissions.IdentitySourceConfigurationPropertiesArgs(\n cognito_user_pool_configuration=aws_native.verifiedpermissions.IdentitySourceCognitoUserPoolConfigurationArgs(\n user_pool_arn=user_pool_arn,\n client_ids=client_ids,\n ),\n ),\n principal_entity_type=principal_entity_type)\npulumi.export(\"identitySourceId\", identity_source.identity_source_id)\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n", + "description": "Definition of AWS::VerifiedPermissions::IdentitySource Resource Type\n\n{{% examples %}}\n## Example Usage\n{{% example %}}\n### Example\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing AwsNative = Pulumi.AwsNative;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var policyStoreId = config.Require(\"policyStoreId\");\n var userPoolArn = config.Require(\"userPoolArn\");\n var clientIds = config.RequireObject\u003cstring[]\u003e(\"clientIds\");\n var principalEntityType = config.Require(\"principalEntityType\");\n var identitySource = new AwsNative.VerifiedPermissions.IdentitySource(\"identitySource\", new()\n {\n PolicyStoreId = policyStoreId,\n Configuration = new AwsNative.VerifiedPermissions.Inputs.IdentitySourceConfiguration0PropertiesArgs\n {\n CognitoUserPoolConfiguration = new AwsNative.VerifiedPermissions.Inputs.IdentitySourceCognitoUserPoolConfigurationArgs\n {\n UserPoolArn = userPoolArn,\n ClientIds = clientIds,\n },\n },\n PrincipalEntityType = principalEntityType,\n });\n\n return new Dictionary\u003cstring, object?\u003e\n {\n [\"identitySourceId\"] = identitySource.IdentitySourceId,\n };\n});\n\n\n```\n\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws-native/sdk/go/aws/verifiedpermissions\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tpolicyStoreId := cfg.Require(\"policyStoreId\")\n\t\tuserPoolArn := cfg.Require(\"userPoolArn\")\n\t\tclientIds := cfg.Require(\"clientIds\")\n\t\tprincipalEntityType := cfg.Require(\"principalEntityType\")\n\t\tidentitySource, err := verifiedpermissions.NewIdentitySource(ctx, \"identitySource\", \u0026verifiedpermissions.IdentitySourceArgs{\n\t\t\tPolicyStoreId: pulumi.String(policyStoreId),\n\t\t\tConfiguration: \u0026verifiedpermissions.IdentitySourceConfiguration0PropertiesArgs{\n\t\t\t\tCognitoUserPoolConfiguration: \u0026verifiedpermissions.IdentitySourceCognitoUserPoolConfigurationArgs{\n\t\t\t\t\tUserPoolArn: pulumi.String(userPoolArn),\n\t\t\t\t\tClientIds: clientIds,\n\t\t\t\t},\n\t\t\t},\n\t\t\tPrincipalEntityType: pulumi.String(principalEntityType),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tctx.Export(\"identitySourceId\", identitySource.IdentitySourceId)\n\t\treturn nil\n\t})\n}\n\n```\n\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws_native from \"@pulumi/aws-native\";\n\nconst config = new pulumi.Config();\nconst policyStoreId = config.require(\"policyStoreId\");\nconst userPoolArn = config.require(\"userPoolArn\");\nconst clientIds = config.requireObject\u003cArray\u003cstring\u003e\u003e(\"clientIds\");\nconst principalEntityType = config.require(\"principalEntityType\");\nconst identitySource = new aws_native.verifiedpermissions.IdentitySource(\"identitySource\", {\n policyStoreId: policyStoreId,\n configuration: {\n cognitoUserPoolConfiguration: {\n userPoolArn: userPoolArn,\n clientIds: clientIds,\n },\n },\n principalEntityType: principalEntityType,\n});\nexport const identitySourceId = identitySource.identitySourceId;\n\n```\n\n```python\nimport pulumi\nimport pulumi_aws_native as aws_native\n\nconfig = pulumi.Config()\npolicy_store_id = config.require(\"policyStoreId\")\nuser_pool_arn = config.require(\"userPoolArn\")\nclient_ids = config.require_object(\"clientIds\")\nprincipal_entity_type = config.require(\"principalEntityType\")\nidentity_source = aws_native.verifiedpermissions.IdentitySource(\"identitySource\",\n policy_store_id=policy_store_id,\n configuration=aws_native.verifiedpermissions.IdentitySourceConfiguration0PropertiesArgs(\n cognito_user_pool_configuration=aws_native.verifiedpermissions.IdentitySourceCognitoUserPoolConfigurationArgs(\n user_pool_arn=user_pool_arn,\n client_ids=client_ids,\n ),\n ),\n principal_entity_type=principal_entity_type)\npulumi.export(\"identitySourceId\", identity_source.identity_source_id)\n\n```\n\n{{% /example %}}\n{{% /examples %}}\n", "properties": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "details": { @@ -240011,7 +240242,14 @@ ], "inputProperties": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "policyStoreId": { @@ -241876,6 +242114,92 @@ "connectionString" ] }, + "aws-native:workspaces:WorkspacesPool": { + "description": "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", + "properties": { + "applicationSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettings" + }, + "bundleId": { + "type": "string" + }, + "capacity": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolCapacity" + }, + "createdAt": { + "type": "string" + }, + "description": { + "type": "string" + }, + "directoryId": { + "type": "string" + }, + "poolArn": { + "type": "string" + }, + "poolId": { + "type": "string" + }, + "poolName": { + "type": "string", + "replaceOnChanges": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + } + }, + "timeoutSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolTimeoutSettings" + } + }, + "type": "object", + "required": [ + "bundleId", + "capacity", + "createdAt", + "directoryId", + "poolArn", + "poolId", + "poolName" + ], + "inputProperties": { + "applicationSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettings" + }, + "bundleId": { + "type": "string" + }, + "capacity": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolCapacity" + }, + "description": { + "type": "string" + }, + "directoryId": { + "type": "string" + }, + "poolName": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/types/aws-native:index:Tag" + } + }, + "timeoutSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolTimeoutSettings" + } + }, + "requiredInputs": [ + "bundleId", + "capacity", + "directoryId" + ] + }, "aws-native:workspacesthinclient:Environment": { "description": "Resource type definition for AWS::WorkSpacesThinClient::Environment.", "properties": { @@ -252165,12 +252489,12 @@ } }, "aws-native:connect:getEvaluationForm": { - "description": "Resource Type definition for AWS::Connect::EvaluationForm", + "description": "Creates an evaluation form for the specified CON instance.", "inputs": { "properties": { "evaluationFormArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) for the evaluation form." + "description": "The Amazon Resource Name (ARN) of the evaluation form." } }, "required": [ @@ -252181,41 +252505,41 @@ "properties": { "description": { "type": "string", - "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." }, "evaluationFormArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) for the evaluation form." + "description": "The Amazon Resource Name (ARN) of the evaluation form." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } } } @@ -264995,7 +265319,7 @@ "properties": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "arn": { "type": "string", @@ -265011,22 +265335,22 @@ }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "status": { "type": "string", - "description": "Malware Protection plan status." + "description": "Status of the Malware Protection plan resource." }, "statusReasons": { "type": "array", "items": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnStatusReasons" }, - "description": "Information about the issue code and message associated to the status of your Malware Protection plan." + "description": "Status details associated with the Malware Protection plan resource status." }, "tags": { "type": "array", @@ -270695,7 +271019,7 @@ }, "runtime": { "type": "string", - "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.\n The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + "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": { "$ref": "#/types/aws-native:lambda:FunctionRuntimeManagementConfig", @@ -279005,6 +279329,10 @@ "type": "boolean", "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": "boolean", + "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": { "$ref": "#/types/aws-native:rds:DbClusterEndpoint" }, @@ -279687,6 +280015,10 @@ "type": "boolean", "description": "The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled." }, + "engineLifecycleSupport": { + "type": "string", + "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": "string", "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." @@ -285408,10 +285740,6 @@ "type": "string", "description": "The Amazon Resource Name (ARN) of the specified signing profile." }, - "profileName": { - "type": "string", - "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": "string", "description": "A version for the signing profile. AWS Signer generates a unique version for each profile of the same profile name." @@ -287301,7 +287629,14 @@ "outputs": { "properties": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "details": { @@ -288395,6 +288730,50 @@ } } }, + "aws-native:workspaces:getWorkspacesPool": { + "description": "Resource Type definition for AWS::WorkSpaces::WorkspacesPool", + "inputs": { + "properties": { + "poolId": { + "type": "string" + } + }, + "required": [ + "poolId" + ] + }, + "outputs": { + "properties": { + "applicationSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolApplicationSettings" + }, + "bundleId": { + "type": "string" + }, + "capacity": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolCapacity" + }, + "createdAt": { + "type": "string" + }, + "description": { + "type": "string" + }, + "directoryId": { + "type": "string" + }, + "poolArn": { + "type": "string" + }, + "poolId": { + "type": "string" + }, + "timeoutSettings": { + "$ref": "#/types/aws-native:workspaces:WorkspacesPoolTimeoutSettings" + } + } + } + }, "aws-native:workspacesthinclient:getEnvironment": { "description": "Resource type definition for AWS::WorkSpacesThinClient::Environment.", "inputs": { diff --git a/reports/missedAutonaming.json b/reports/missedAutonaming.json index c375d761de..7b343aaf9b 100644 --- a/reports/missedAutonaming.json +++ b/reports/missedAutonaming.json @@ -2059,37 +2059,37 @@ "properties": { "description": { "type": "string", - "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." }, "instanceArn": { "type": "string", - "description": "The Amazon Resource Name (ARN) of the instance." + "description": "The identifier of the Amazon Connect instance." }, "items": { "type": "array", "items": { "$ref": "#/types/aws-native:connect:EvaluationFormBaseItem" }, - "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" }, "scoringStrategy": { "$ref": "#/types/aws-native:connect:EvaluationFormScoringStrategy", - "description": "The scoring strategy." + "description": "A scoring strategy of the evaluation form." }, "status": { "$ref": "#/types/aws-native:connect:EvaluationFormStatus", - "description": "The status of the evaluation form." + "description": "The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``" }, "tags": { "type": "array", "items": { "$ref": "#/types/aws-native:index:Tag" }, - "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\"} }." }, "title": { "type": "string", - "description": "The title of the evaluation form." + "description": "A title of the evaluation form." } } }, @@ -3260,10 +3260,6 @@ "$ref": "#/types/aws-native:dms:ReplicationConfigComputeConfig", "description": "Configuration parameters for provisioning an AWS DMS Serverless replication." }, - "replicationConfigArn": { - "type": "string", - "description": "The Amazon Resource Name (ARN) of the Replication Config" - }, "replicationConfigIdentifier": { "type": "string", "description": "A unique identifier of replication configuration" @@ -7089,15 +7085,15 @@ "properties": { "actions": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnActions", - "description": "Information about whether the tags will be added to the S3 object after scanning." + "description": "Specifies the action that is to be applied to the Malware Protection plan resource." }, "protectedResource": { "$ref": "#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource", - "description": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource." + "description": "Information about the protected resource. Presently, S3Bucket is the only supported protected resource." }, "role": { "type": "string", - "description": "IAM role that includes the permissions required to scan and add tags to the associated protected resource." + "description": "IAM role that includes the permissions required to scan and (optionally) add tags to the associated protected resource." }, "tags": { "type": "array", @@ -9918,6 +9914,10 @@ "type": "boolean", "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": "boolean", + "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." + }, "engine": { "type": "string", "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" @@ -10444,6 +10444,10 @@ "$ref": "#/types/aws-native:rds:GlobalClusterEngine", "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": "string", + "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": "string", "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." @@ -11623,26 +11627,6 @@ } } }, - "aws-native:signer:SigningProfile": { - "cfTypeName": "AWS::Signer::SigningProfile", - "properties": { - "platformId": { - "$ref": "#/types/aws-native:signer:SigningProfilePlatformId", - "description": "The ID of the target signing platform." - }, - "signatureValidityPeriod": { - "$ref": "#/types/aws-native:signer:SigningProfileSignatureValidityPeriod", - "description": "Signature validity period of the profile." - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/types/aws-native:index:Tag" - }, - "description": "A list of tags associated with the signing profile." - } - } - }, "aws-native:sns:TopicInlinePolicy": { "cfTypeName": "AWS::SNS::TopicInlinePolicy", "properties": { @@ -12144,7 +12128,14 @@ "cfTypeName": "AWS::VerifiedPermissions::IdentitySource", "properties": { "configuration": { - "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfigurationProperties", + "oneOf": [ + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration0Properties" + }, + { + "$ref": "#/types/aws-native:verifiedpermissions:IdentitySourceConfiguration1Properties" + } + ], "description": "Contains configuration information about an identity source." }, "policyStoreId": {