diff --git a/samtranslator/schema/schema.json b/samtranslator/schema/schema.json index 31b46dc08..58bbbbee4 100644 --- a/samtranslator/schema/schema.json +++ b/samtranslator/schema/schema.json @@ -24322,24 +24322,36 @@ "additionalProperties": false, "properties": { "BusinessName": { + "markdownDescription": "Returns the name for the business associated with this profile.", + "title": "BusinessName", "type": "string" }, "Email": { + "markdownDescription": "", + "title": "Email", "type": "string" }, "Logging": { + "markdownDescription": "Specifies whether or not logging is enabled for this profile.", + "title": "Logging", "type": "string" }, "Name": { + "markdownDescription": "Returns the display name for profile.", + "title": "Name", "type": "string" }, "Phone": { + "markdownDescription": "", + "title": "Phone", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A key-value pair for a specific profile. Tags are metadata that you can use to search for and group capabilities for various purposes.", + "title": "Tags", "type": "array" } }, @@ -24408,30 +24420,46 @@ "additionalProperties": false, "properties": { "EdiType": { - "$ref": "#/definitions/AWS::B2BI::Transformer.EdiType" + "$ref": "#/definitions/AWS::B2BI::Transformer.EdiType", + "markdownDescription": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.", + "title": "EdiType" }, "FileFormat": { + "markdownDescription": "Returns that the currently supported file formats for EDI transformations are `JSON` and `XML` .", + "title": "FileFormat", "type": "string" }, "MappingTemplate": { + "markdownDescription": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "title": "MappingTemplate", "type": "string" }, "ModifiedAt": { + "markdownDescription": "Returns a timestamp representing the date and time for the most recent change for the transformer object.", + "title": "ModifiedAt", "type": "string" }, "Name": { + "markdownDescription": "Returns the descriptive name for the transformer.", + "title": "Name", "type": "string" }, "SampleDocument": { + "markdownDescription": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "title": "SampleDocument", "type": "string" }, "Status": { + "markdownDescription": "Returns the state of the newly created transformer. The transformer can be either `active` or `inactive` . For the transformer to be used in a capability, its status must `active` .", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A key-value pair for a specific transformer. Tags are metadata that you can use to search for and group capabilities for various purposes.", + "title": "Tags", "type": "array" } }, @@ -24469,7 +24497,9 @@ "additionalProperties": false, "properties": { "X12Details": { - "$ref": "#/definitions/AWS::B2BI::Transformer.X12Details" + "$ref": "#/definitions/AWS::B2BI::Transformer.X12Details", + "markdownDescription": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.", + "title": "X12Details" } }, "required": [ @@ -24481,9 +24511,13 @@ "additionalProperties": false, "properties": { "TransactionSet": { + "markdownDescription": "Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.", + "title": "TransactionSet", "type": "string" }, "Version": { + "markdownDescription": "Returns the version to use for the specified X12 transaction set. Supported versions are `4010` , `4030` , and `5010` .", + "title": "Version", "type": "string" } }, @@ -30876,7 +30910,7 @@ "type": "string" }, "ImageId": { - "markdownDescription": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (default): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (default): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", + "markdownDescription": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2023 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (end of maintenance support December 2023): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (end of maintenance support December 2023): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", "title": "ImageId", "type": "string" }, @@ -36080,7 +36114,7 @@ "type": "array" }, "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .\n\n> Only the management account can configure a CloudWatch Logs log group for an organization trail.", + "markdownDescription": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, @@ -46568,7 +46602,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" }, @@ -47336,7 +47370,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -47449,7 +47483,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -47645,7 +47679,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -48210,7 +48244,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -57689,7 +57723,7 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.", + "markdownDescription": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.\n\nIf you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.", "title": "Domain", "type": "string" }, @@ -57893,7 +57927,7 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "markdownDescription": "Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.", "title": "Domain", "type": "string" }, @@ -57903,7 +57937,7 @@ "type": "string" }, "Password": { - "markdownDescription": "Specifies the password of the user who has the permissions to access files and folders in the file system.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "markdownDescription": "Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.", "title": "Password", "type": "string" }, @@ -58519,7 +58553,7 @@ "type": "array" }, "Domain": { - "markdownDescription": "Specifies the Windows domain name that your SMB file server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations.", + "markdownDescription": "Specifies the name of the Active Directory domain that your SMB file server belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.", "title": "Domain", "type": "string" }, @@ -58918,7 +58952,7 @@ "type": "string" }, "LogLevel": { - "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\nIf you set `LogLevel` to `OFF` , no logs are published. `BASIC` publishes logs on errors for individual files transferred. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked.", + "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\n- `BASIC` - Publishes logs with only basic information (such as transfer errors).\n- `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.\n- `OFF` - No logs are published.", "title": "LogLevel", "type": "string" }, @@ -58928,7 +58962,7 @@ "type": "string" }, "ObjectTags": { - "markdownDescription": "Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.\n\nDefault Value: `PRESERVE`", + "markdownDescription": "Specifies whether you want DataSync to `PRESERVE` object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.", "title": "ObjectTags", "type": "string" }, @@ -91141,7 +91175,7 @@ "properties": { "CloudWatchLogsConfiguration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration", - "markdownDescription": "The configuration for experiment logging to CloudWatch Logs .", + "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs.", "title": "CloudWatchLogsConfiguration" }, "LogSchemaVersion": { @@ -91151,7 +91185,7 @@ }, "S3Configuration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.S3Configuration", - "markdownDescription": "The configuration for experiment logging to Amazon S3 .", + "markdownDescription": "The configuration for experiment logging to Amazon S3.", "title": "S3Configuration" } }, @@ -91192,7 +91226,7 @@ }, "Parameters": { "additionalProperties": true, - "markdownDescription": "The parameters for the resource type.", + "markdownDescription": "The resource type parameters.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -100545,7 +100579,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -100580,7 +100614,7 @@ "additionalProperties": false, "properties": { "ConnectorArn": { - "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "ConnectorArn", "type": "string" }, @@ -100590,7 +100624,7 @@ "type": "string" }, "Parameters": { - "markdownDescription": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "Parameters", "type": "object" } @@ -100698,7 +100732,7 @@ "additionalProperties": false, "properties": { "ConnectorArn": { - "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "ConnectorArn", "type": "string" }, @@ -100708,7 +100742,7 @@ "type": "string" }, "Parameters": { - "markdownDescription": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "Parameters", "type": "object" } @@ -100765,7 +100799,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -100997,7 +101031,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101229,7 +101263,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101307,13 +101341,13 @@ "additionalProperties": false, "properties": { "IsolationMode": { - "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "title": "IsolationMode", "type": "string" }, "RunAs": { "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.RunAs", - "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .", + "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) .", "title": "RunAs" } }, @@ -101571,13 +101605,13 @@ "additionalProperties": false, "properties": { "IsolationMode": { - "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "title": "IsolationMode", "type": "string" }, "RunAs": { "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.RunAs", - "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .", + "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) .", "title": "RunAs" } }, @@ -101736,7 +101770,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101956,7 +101990,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -102200,7 +102234,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -102398,7 +102432,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "S3Uri": { @@ -102423,7 +102457,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "SageMakerJobArn": { @@ -102686,7 +102720,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "S3Uri": { @@ -102711,7 +102745,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "SageMakerJobArn": { @@ -102794,7 +102828,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -110672,7 +110706,7 @@ "properties": { "S3Config": { "$ref": "#/definitions/AWS::InternetMonitor::Monitor.S3Config", - "markdownDescription": "The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.", + "markdownDescription": "The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` or `DISABLED` , depending on whether you choose to deliver internet measurements to S3 logs.", "title": "S3Config" } }, @@ -110703,17 +110737,17 @@ "additionalProperties": false, "properties": { "BucketName": { - "markdownDescription": "The Amazon S3 bucket name for internet measurements publishing.", + "markdownDescription": "The Amazon S3 bucket name.", "title": "BucketName", "type": "string" }, "BucketPrefix": { - "markdownDescription": "An optional Amazon S3 bucket prefix for internet measurements publishing.", + "markdownDescription": "The Amazon S3 bucket prefix.", "title": "BucketPrefix", "type": "string" }, "LogDeliveryStatus": { - "markdownDescription": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise.", + "markdownDescription": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.", "title": "LogDeliveryStatus", "type": "string" } @@ -113619,12 +113653,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "", + "markdownDescription": "A summary of the package being created. This can be used to outline the package's contents or purpose.", "title": "Description", "type": "string" }, "PackageName": { - "markdownDescription": "", + "markdownDescription": "The name of the new software package.", "title": "PackageName", "type": "string" }, @@ -113632,7 +113666,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to manage the package.", "title": "Tags", "type": "array" } @@ -113696,7 +113730,7 @@ "properties": { "Attributes": { "additionalProperties": true, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to define a package version\u2019s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.\n\nThe combined size of all the attributes on a package version is limited to 3KB.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -113706,12 +113740,12 @@ "type": "object" }, "Description": { - "markdownDescription": "", + "markdownDescription": "A summary of the package version being created. This can be used to outline the package's contents or purpose.", "title": "Description", "type": "string" }, "PackageName": { - "markdownDescription": "", + "markdownDescription": "The name of the associated software package.", "title": "PackageName", "type": "string" }, @@ -113719,12 +113753,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to manage the package version.", "title": "Tags", "type": "array" }, "VersionName": { - "markdownDescription": "", + "markdownDescription": "The name of the new package version.", "title": "VersionName", "type": "string" } @@ -232853,12 +232887,16 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -232868,6 +232906,8 @@ "additionalProperties": false, "properties": { "RepositoryUrl": { + "markdownDescription": "The URL of the Git repository.", + "title": "RepositoryUrl", "type": "string" } }, @@ -232880,7 +232920,9 @@ "additionalProperties": false, "properties": { "EFSFileSystemConfig": { - "$ref": "#/definitions/AWS::SageMaker::Domain.EFSFileSystemConfig" + "$ref": "#/definitions/AWS::SageMaker::Domain.EFSFileSystemConfig", + "markdownDescription": "The settings for a custom Amazon EFS file system.", + "title": "EFSFileSystemConfig" } }, "type": "object" @@ -232914,9 +232956,13 @@ "additionalProperties": false, "properties": { "Gid": { + "markdownDescription": "The POSIX group ID.", + "title": "Gid", "type": "number" }, "Uid": { + "markdownDescription": "The POSIX user ID.", + "title": "Uid", "type": "number" } }, @@ -232930,9 +232976,13 @@ "additionalProperties": false, "properties": { "DefaultEbsVolumeSizeInGb": { + "markdownDescription": "The default size of the EBS storage volume for a private space.", + "title": "DefaultEbsVolumeSizeInGb", "type": "number" }, "MaximumEbsVolumeSizeInGb": { + "markdownDescription": "The maximum size of the EBS storage volume for a private space.", + "title": "MaximumEbsVolumeSizeInGb", "type": "number" } }, @@ -232978,7 +233028,9 @@ "additionalProperties": false, "properties": { "DefaultEbsStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultEbsStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultEbsStorageSettings", + "markdownDescription": "The default EBS storage settings for a private space.", + "title": "DefaultEbsStorageSettings" } }, "type": "object" @@ -233006,9 +233058,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The ID of your Amazon EFS file system.", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.", + "title": "FileSystemPath", "type": "string" } }, @@ -233024,21 +233080,29 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CodeRepository" }, + "markdownDescription": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "title": "CodeRepositories", "type": "array" }, "CustomImages": { "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -233189,18 +233253,26 @@ "additionalProperties": false, "properties": { "CodeEditorAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.CodeEditorAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.CodeEditorAppSettings", + "markdownDescription": "The Code Editor application settings.", + "title": "CodeEditorAppSettings" }, "CustomFileSystemConfigs": { "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomFileSystemConfig" }, + "markdownDescription": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "title": "CustomFileSystemConfigs", "type": "array" }, "CustomPosixUserConfig": { - "$ref": "#/definitions/AWS::SageMaker::Domain.CustomPosixUserConfig" + "$ref": "#/definitions/AWS::SageMaker::Domain.CustomPosixUserConfig", + "markdownDescription": "Details about the POSIX identity that is used for file system operations.", + "title": "CustomPosixUserConfig" }, "DefaultLandingUri": { + "markdownDescription": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", + "title": "DefaultLandingUri", "type": "string" }, "ExecutionRole": { @@ -233209,7 +233281,9 @@ "type": "string" }, "JupyterLabAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterLabAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterLabAppSettings", + "markdownDescription": "The settings for the JupyterLab application.", + "title": "JupyterLabAppSettings" }, "JupyterServerAppSettings": { "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings", @@ -233245,9 +233319,13 @@ "title": "SharingSettings" }, "SpaceStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceStorageSettings", + "markdownDescription": "The storage settings for a private space.", + "title": "SpaceStorageSettings" }, "StudioWebPortal": { + "markdownDescription": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain.", + "title": "StudioWebPortal", "type": "string" } }, @@ -240362,12 +240440,16 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -240377,6 +240459,8 @@ "additionalProperties": false, "properties": { "RepositoryUrl": { + "markdownDescription": "The URL of the Git repository.", + "title": "RepositoryUrl", "type": "string" } }, @@ -240389,7 +240473,9 @@ "additionalProperties": false, "properties": { "EFSFileSystemConfig": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.EFSFileSystemConfig" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.EFSFileSystemConfig", + "markdownDescription": "The settings for a custom Amazon EFS file system.", + "title": "EFSFileSystemConfig" } }, "type": "object" @@ -240423,9 +240509,13 @@ "additionalProperties": false, "properties": { "Gid": { + "markdownDescription": "The POSIX group ID.", + "title": "Gid", "type": "number" }, "Uid": { + "markdownDescription": "The POSIX user ID.", + "title": "Uid", "type": "number" } }, @@ -240439,9 +240529,13 @@ "additionalProperties": false, "properties": { "DefaultEbsVolumeSizeInGb": { + "markdownDescription": "The default size of the EBS storage volume for a private space.", + "title": "DefaultEbsVolumeSizeInGb", "type": "number" }, "MaximumEbsVolumeSizeInGb": { + "markdownDescription": "The maximum size of the EBS storage volume for a private space.", + "title": "MaximumEbsVolumeSizeInGb", "type": "number" } }, @@ -240455,7 +240549,9 @@ "additionalProperties": false, "properties": { "DefaultEbsStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultEbsStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultEbsStorageSettings", + "markdownDescription": "The default EBS storage settings for a private space.", + "title": "DefaultEbsStorageSettings" } }, "type": "object" @@ -240464,9 +240560,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The ID of your Amazon EFS file system.", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.", + "title": "FileSystemPath", "type": "string" } }, @@ -240482,21 +240582,29 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeRepository" }, + "markdownDescription": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "title": "CodeRepositories", "type": "array" }, "CustomImages": { "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -240594,18 +240702,26 @@ "additionalProperties": false, "properties": { "CodeEditorAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeEditorAppSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeEditorAppSettings", + "markdownDescription": "The Code Editor application settings.", + "title": "CodeEditorAppSettings" }, "CustomFileSystemConfigs": { "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomFileSystemConfig" }, + "markdownDescription": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "title": "CustomFileSystemConfigs", "type": "array" }, "CustomPosixUserConfig": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomPosixUserConfig" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomPosixUserConfig", + "markdownDescription": "Details about the POSIX identity that is used for file system operations.", + "title": "CustomPosixUserConfig" }, "DefaultLandingUri": { + "markdownDescription": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", + "title": "DefaultLandingUri", "type": "string" }, "ExecutionRole": { @@ -240614,7 +240730,9 @@ "type": "string" }, "JupyterLabAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterLabAppSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterLabAppSettings", + "markdownDescription": "The settings for the JupyterLab application.", + "title": "JupyterLabAppSettings" }, "JupyterServerAppSettings": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterServerAppSettings", @@ -240645,9 +240763,13 @@ "title": "SharingSettings" }, "SpaceStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings", + "markdownDescription": "The storage settings for a private space.", + "title": "SpaceStorageSettings" }, "StudioWebPortal": { + "markdownDescription": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain.", + "title": "StudioWebPortal", "type": "string" } }, diff --git a/schema_source/cloudformation-docs.json b/schema_source/cloudformation-docs.json index 6f7e76b88..38124ef56 100644 --- a/schema_source/cloudformation-docs.json +++ b/schema_source/cloudformation-docs.json @@ -2708,8 +2708,8 @@ "TagItems": "The items of the tag." }, "AWS::AppStream::AppBlock TagItems": { - "TagKey": "The key of the tag.", - "TagValue": "The value of the tag." + "Key": "", + "Value": "" }, "AWS::AppStream::AppBlockBuilder": { "AccessEndpoints": "The access endpoints of the app block builder.", @@ -2758,8 +2758,8 @@ "TagItems": "The items of the tag." }, "AWS::AppStream::Application TagItems": { - "TagKey": "The key of the tag.", - "TagValue": "The value of the tag." + "Key": "", + "Value": "" }, "AWS::AppStream::ApplicationEntitlementAssociation": { "ApplicationIdentifier": "The identifier of the application.", @@ -3846,6 +3846,82 @@ "ScaleOutCooldown": "The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.", "TargetValue": "The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360." }, + "AWS::B2BI::Capability": { + "Configuration": "Specifies a structure that contains the details for a capability.", + "InstructionsDocuments": "Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.", + "Name": "The display name of the capability.", + "Tags": "Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.", + "Type": "Returns the type of the capability. Currently, only `edi` is supported." + }, + "AWS::B2BI::Capability CapabilityConfiguration": { + "Edi": "An EDI (electronic data interchange) configuration object." + }, + "AWS::B2BI::Capability EdiConfiguration": { + "InputLocation": "Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object.", + "OutputLocation": "Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object.", + "TransformerId": "Returns the system-assigned unique identifier for the transformer.", + "Type": "Returns the type of the capability. Currently, only `edi` is supported." + }, + "AWS::B2BI::Capability EdiType": { + "X12Details": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents." + }, + "AWS::B2BI::Capability S3Location": { + "BucketName": "Specifies the name of the Amazon S3 bucket.", + "Key": "Specifies the Amazon S3 key for the file location." + }, + "AWS::B2BI::Capability Tag": { + "Key": "Specifies the name assigned to the tag that you create.", + "Value": "Contains one or more values that you assigned to the key name that you create." + }, + "AWS::B2BI::Capability X12Details": { + "TransactionSet": "Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.", + "Version": "Returns the version to use for the specified X12 transaction set. Supported versions are `4010` , `4030` , and `5010` ." + }, + "AWS::B2BI::Partnership": { + "Capabilities": "Returns one or more capabilities associated with this partnership.", + "Email": "", + "Name": "Returns the name of the partnership.", + "Phone": "", + "ProfileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.", + "Tags": "A key-value pair for a specific partnership. Tags are metadata that you can use to search for and group capabilities for various purposes." + }, + "AWS::B2BI::Partnership Tag": { + "Key": "Specifies the name assigned to the tag that you create.", + "Value": "Contains one or more values that you assigned to the key name that you create." + }, + "AWS::B2BI::Profile": { + "BusinessName": "Returns the name for the business associated with this profile.", + "Email": "", + "Logging": "Specifies whether or not logging is enabled for this profile.", + "Name": "Returns the display name for profile.", + "Phone": "", + "Tags": "A key-value pair for a specific profile. Tags are metadata that you can use to search for and group capabilities for various purposes." + }, + "AWS::B2BI::Profile Tag": { + "Key": "Specifies the name assigned to the tag that you create.", + "Value": "Contains one or more values that you assigned to the key name that you create." + }, + "AWS::B2BI::Transformer": { + "EdiType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.", + "FileFormat": "Returns that the currently supported file formats for EDI transformations are `JSON` and `XML` .", + "MappingTemplate": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "ModifiedAt": "Returns a timestamp representing the date and time for the most recent change for the transformer object.", + "Name": "Returns the descriptive name for the transformer.", + "SampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "Status": "Returns the state of the newly created transformer. The transformer can be either `active` or `inactive` . For the transformer to be used in a capability, its status must `active` .", + "Tags": "A key-value pair for a specific transformer. Tags are metadata that you can use to search for and group capabilities for various purposes." + }, + "AWS::B2BI::Transformer EdiType": { + "X12Details": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents." + }, + "AWS::B2BI::Transformer Tag": { + "Key": "Specifies the name assigned to the tag that you create.", + "Value": "Contains one or more values that you assigned to the key name that you create." + }, + "AWS::B2BI::Transformer X12Details": { + "TransactionSet": "Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.", + "Version": "Returns the version to use for the specified X12 transaction set. Supported versions are `4010` , `4030` , and `5010` ." + }, "AWS::Backup::BackupPlan": { "BackupPlan": "Uniquely identifies the backup plan to be associated with the selection of resources.", "BackupPlanTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan." @@ -4784,7 +4860,7 @@ "AutomaticStopTimeMinutes": "The number of minutes until the running instance is shut down after the environment was last used.", "ConnectionType": "The connection type used for connecting to an Amazon EC2 environment. Valid values are `CONNECT_SSH` (default) and `CONNECT_SSM` (connected through AWS Systems Manager ).", "Description": "The description of the environment to create.", - "ImageId": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (default): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (default): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", + "ImageId": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2023 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (end of maintenance support December 2023): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (end of maintenance support December 2023): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", "InstanceType": "The type of instance to connect to the environment (for example, `t2.micro` ).", "Name": "The name of the environment.", "OwnerArn": "The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS Identity and Access Management principal. If this value is not specified, the ARN defaults to this environment's creator.", @@ -5497,7 +5573,7 @@ }, "AWS::CloudTrail::Trail": { "AdvancedEventSelectors": "Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either `AdvancedEventSelectors` or `EventSelectors` , but not both. If you apply `AdvancedEventSelectors` to a trail, any existing `EventSelectors` are overwritten. For more information about advanced event selectors, see [Logging data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the *AWS CloudTrail User Guide* .", - "CloudWatchLogsLogGroupArn": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .\n\n> Only the management account can configure a CloudWatch Logs log group for an organization trail.", + "CloudWatchLogsLogGroupArn": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .", "CloudWatchLogsRoleArn": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.", "EnableLogFileValidation": "Specifies whether log file validation is enabled. The default is false.\n\n> When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.", "EventSelectors": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.\n\nYou can configure up to five event selectors for a trail.\n\nYou cannot apply both event selectors and advanced event selectors to a trail.", @@ -7053,7 +7129,7 @@ "Description": "The description for the hours of operation.", "InstanceArn": "The Amazon Resource Name (ARN) of the instance.", "Name": "The name for the hours of operation.", - "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "TimeZone": "The time zone for the hours of operation." }, "AWS::Connect::HoursOfOperation HoursOfOperationConfig": { @@ -7155,7 +7231,7 @@ "OutboundCallerConfig": "The outbound caller ID name, number, and outbound whisper flow.", "QuickConnectArns": "The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.", "Status": "The status of the queue.", - "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." + "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." }, "AWS::Connect::Queue OutboundCallerConfig": { "OutboundCallerIdName": "The caller ID name.", @@ -7171,7 +7247,7 @@ "InstanceArn": "The Amazon Resource Name (ARN) of the instance.", "Name": "The name of the quick connect.", "QuickConnectConfig": "Contains information about the quick connect.", - "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." + "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." }, "AWS::Connect::QuickConnect PhoneNumberQuickConnectConfig": { "PhoneNumber": "The phone number in E.164 format." @@ -7202,7 +7278,7 @@ "MediaConcurrencies": "The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.", "Name": "The name of the routing profile.", "QueueConfigs": "The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.", - "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." + "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." }, "AWS::Connect::RoutingProfile CrossChannelBehavior": { "BehaviorType": "Specifies the other channels that can be routed to an agent handling their current channel." @@ -7283,7 +7359,7 @@ "Permissions": "Permissions assigned to the security profile. For a list of valid permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html) .", "SecurityProfileName": "The name for the security profile.", "TagRestrictedResources": "The list of resources that a security profile applies tag restrictions to in Amazon Connect.", - "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." + "Tags": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }." }, "AWS::Connect::SecurityProfile Tag": { "Key": "", @@ -8878,7 +8954,7 @@ "SMB": "Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM." }, "AWS::DataSync::LocationFSxONTAP SMB": { - "Domain": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.", + "Domain": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.\n\nIf you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.", "MountOptions": "Specifies how DataSync can access a location using the SMB protocol.", "Password": "Specifies the password of a user who has permission to access your SVM.", "User": "Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.\n\nIf you provide a user in your Active Directory, note the following:\n\n- If you're using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group.\n- If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.\n\nMake sure that the user has the permissions it needs to copy the data you want:\n\n- `SE_TCB_NAME` : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).\n- `SE_SECURITY_NAME` : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see [Ownership and permissions-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions) ." @@ -8911,9 +8987,9 @@ "Value": "" }, "AWS::DataSync::LocationFSxWindows": { - "Domain": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "Domain": "Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.", "FsxFilesystemArn": "Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.", - "Password": "Specifies the password of the user who has the permissions to access files and folders in the file system.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "Password": "Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.", "SecurityGroupArns": "The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.\n\n*Pattern* : `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$`\n\n*Length constraints* : Maximum length of 128.", "Subdirectory": "Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).", "Tags": "Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.", @@ -8999,7 +9075,7 @@ }, "AWS::DataSync::LocationSMB": { "AgentArns": "The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.", - "Domain": "Specifies the Windows domain name that your SMB file server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations.", + "Domain": "Specifies the name of the Active Directory domain that your SMB file server belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.", "MountOptions": "Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.", "Password": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.", "ServerHostname": "Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.\n\n> You can't specify an IP version 6 (IPv6) address.", @@ -9061,9 +9137,9 @@ "Atime": "A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to). If you set `Atime` to `BEST_EFFORT` , AWS DataSync attempts to preserve the original `Atime` attribute on all source files (that is, the version before the PREPARING phase). However, `Atime` 's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.\n\nDefault value: `BEST_EFFORT`\n\n`BEST_EFFORT` : Attempt to preserve the per-file `Atime` value (recommended).\n\n`NONE` : Ignore `Atime` .\n\n> If `Atime` is set to `BEST_EFFORT` , `Mtime` must be set to `PRESERVE` .\n> \n> If `Atime` is set to `NONE` , `Mtime` must also be `NONE` .", "BytesPerSecond": "A value that limits the bandwidth used by AWS DataSync . For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to `1048576` (=1024*1024).", "Gid": "The group ID (GID) of the file's owners.\n\nDefault value: `INT_VALUE`\n\n`INT_VALUE` : Preserve the integer value of the user ID (UID) and group ID (GID) (recommended).\n\n`NAME` : Currently not supported.\n\n`NONE` : Ignore the UID and GID.", - "LogLevel": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\nIf you set `LogLevel` to `OFF` , no logs are published. `BASIC` publishes logs on errors for individual files transferred. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked.", + "LogLevel": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\n- `BASIC` - Publishes logs with only basic information (such as transfer errors).\n- `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.\n- `OFF` - No logs are published.", "Mtime": "A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Preserve original `Mtime` (recommended)\n\n`NONE` : Ignore `Mtime` .\n\n> If `Mtime` is set to `PRESERVE` , `Atime` must be set to `BEST_EFFORT` .\n> \n> If `Mtime` is set to `NONE` , `Atime` must also be set to `NONE` .", - "ObjectTags": "Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.\n\nDefault Value: `PRESERVE`", + "ObjectTags": "Specifies whether you want DataSync to `PRESERVE` object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.", "OverwriteMode": "Specifies whether DataSync should modify or preserve data at the destination location.\n\n- `ALWAYS` (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.\n\nIf DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see [Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) .\n- `NEVER` - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.", "PosixPermissions": "A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file. This option should be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see [Metadata Copied by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) .\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Preserve POSIX-style permissions (recommended).\n\n`NONE` : Ignore permissions.\n\n> AWS DataSync can preserve extant permissions of a source location.", "PreserveDeletedFiles": "A value that specifies whether files in the destination that don't exist in the source file system are preserved. This option can affect your storage costs. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) in the *AWS DataSync User Guide* .\n\nDefault value: `PRESERVE`\n\n`PRESERVE` : Ignore destination files that aren't present in the source (recommended).\n\n`REMOVE` : Delete destination files that aren't present in the source.", @@ -14008,9 +14084,9 @@ "EmptyTargetResolutionMode": "The empty target resolution mode for an experiment template." }, "AWS::FIS::ExperimentTemplate ExperimentTemplateLogConfiguration": { - "CloudWatchLogsConfiguration": "The configuration for experiment logging to CloudWatch Logs .", + "CloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs.", "LogSchemaVersion": "The schema version.", - "S3Configuration": "The configuration for experiment logging to Amazon S3 ." + "S3Configuration": "The configuration for experiment logging to Amazon S3." }, "AWS::FIS::ExperimentTemplate ExperimentTemplateStopCondition": { "Source": "The source for the stop condition.", @@ -14018,7 +14094,7 @@ }, "AWS::FIS::ExperimentTemplate ExperimentTemplateTarget": { "Filters": "The filters to apply to identify target resources using specific attributes.", - "Parameters": "The parameters for the resource type.", + "Parameters": "The resource type parameters.", "ResourceArns": "The Amazon Resource Names (ARNs) of the targets.", "ResourceTags": "The tags for the target resources.", "ResourceType": "The resource type.", @@ -15426,12 +15502,12 @@ "AWS::Greengrass::ConnectorDefinition": { "InitialVersion": "The connector definition version to include when the connector definition is created. A connector definition version contains a list of [`connector`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html) property types.\n\n> To associate a connector definition version after the connector definition is created, create an [`AWS::Greengrass::ConnectorDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and specify the ID of this connector definition.", "Name": "The name of the connector definition.", - "Tags": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::ConnectorDefinition Connector": { - "ConnectorArn": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "ConnectorArn": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "Id": "A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", - "Parameters": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) ." + "Parameters": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) ." }, "AWS::Greengrass::ConnectorDefinition ConnectorDefinitionVersion": { "Connectors": "The connectors in this version. Only one instance of a given connector can be added to a connector definition version at a time." @@ -15441,14 +15517,14 @@ "Connectors": "The connectors in this version. Only one instance of a given connector can be added to the connector definition version at a time." }, "AWS::Greengrass::ConnectorDefinitionVersion Connector": { - "ConnectorArn": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "ConnectorArn": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "Id": "A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", - "Parameters": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) ." + "Parameters": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) ." }, "AWS::Greengrass::CoreDefinition": { "InitialVersion": "The core definition version to include when the core definition is created. Currently, a core definition version can contain only one [`core`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .\n\n> To associate a core definition version after the core definition is created, create an [`AWS::Greengrass::CoreDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-coredefinitionversion.html) resource and specify the ID of this core definition.", "Name": "The name of the core definition.", - "Tags": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::CoreDefinition Core": { "CertificateArn": "The Amazon Resource Name (ARN) of the device certificate for the core. This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.", @@ -15472,7 +15548,7 @@ "AWS::Greengrass::DeviceDefinition": { "InitialVersion": "The device definition version to include when the device definition is created. A device definition version contains a list of [`device`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-devicedefinition-device.html) property types.\n\n> To associate a device definition version after the device definition is created, create an [`AWS::Greengrass::DeviceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-devicedefinitionversion.html) resource and specify the ID of this device definition.", "Name": "The name of the device definition.", - "Tags": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::DeviceDefinition Device": { "CertificateArn": "The Amazon Resource Name (ARN) of the device certificate for the device. This X.509 certificate is used to authenticate the device with AWS IoT and AWS IoT Greengrass services.", @@ -15496,7 +15572,7 @@ "AWS::Greengrass::FunctionDefinition": { "InitialVersion": "The function definition version to include when the function definition is created. A function definition version contains a list of [`function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinition-function.html) property types.\n\n> To associate a function definition version after the function definition is created, create an [`AWS::Greengrass::FunctionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-functiondefinitionversion.html) resource and specify the ID of this function definition.", "Name": "The name of the function definition.", - "Tags": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::FunctionDefinition DefaultConfig": { "Execution": "Configuration settings for the Lambda execution environment on the AWS IoT Greengrass core." @@ -15508,8 +15584,8 @@ "Variables": "Environment variables for the Lambda function." }, "AWS::Greengrass::FunctionDefinition Execution": { - "IsolationMode": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", - "RunAs": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) ." + "IsolationMode": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "RunAs": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) ." }, "AWS::Greengrass::FunctionDefinition Function": { "FunctionArn": "The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.", @@ -15552,8 +15628,8 @@ "Variables": "Environment variables for the Lambda function." }, "AWS::Greengrass::FunctionDefinitionVersion Execution": { - "IsolationMode": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", - "RunAs": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) ." + "IsolationMode": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "RunAs": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) ." }, "AWS::Greengrass::FunctionDefinitionVersion Function": { "FunctionArn": "The Amazon Resource Name (ARN) of the alias (recommended) or version of the referenced Lambda function.", @@ -15581,7 +15657,7 @@ "InitialVersion": "The group version to include when the group is created. A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need.\n\n> To associate a group version after the group is created, create an [`AWS::Greengrass::GroupVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html) resource and specify the ID of this group.", "Name": "The name of the group.", "RoleArn": "The Amazon Resource Name (ARN) of the IAM role attached to the group. This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.", - "Tags": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::Group GroupVersion": { "ConnectorDefinitionVersionArn": "The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.", @@ -15605,7 +15681,7 @@ "AWS::Greengrass::LoggerDefinition": { "InitialVersion": "The logger definition version to include when the logger definition is created. A logger definition version contains a list of [`logger`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-loggerdefinition-logger.html) property types.\n\n> To associate a logger definition version after the logger definition is created, create an [`AWS::Greengrass::LoggerDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-loggerdefinitionversion.html) resource and specify the ID of this logger definition.", "Name": "The name of the logger definition.", - "Tags": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::LoggerDefinition Logger": { "Component": "The source of the log event. Valid values are `GreengrassSystem` or `Lambda` . When `GreengrassSystem` is used, events from Greengrass system components are logged. When `Lambda` is used, events from user-defined Lambda functions are logged.", @@ -15631,7 +15707,7 @@ "AWS::Greengrass::ResourceDefinition": { "InitialVersion": "The resource definition version to include when the resource definition is created. A resource definition version contains a list of [`resource instance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html) property types.\n\n> To associate a resource definition version after the resource definition is created, create an [`AWS::Greengrass::ResourceDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html) resource and specify the ID of this resource definition.", "Name": "The name of the resource definition.", - "Tags": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::ResourceDefinition GroupOwnerSetting": { "AutoAddGroupOwner": "Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process. This gives the Lambda process the file access permissions of the Linux group.", @@ -15667,12 +15743,12 @@ }, "AWS::Greengrass::ResourceDefinition S3MachineLearningModelResourceData": { "DestinationPath": "The absolute local path of the resource inside the Lambda environment.", - "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "S3Uri": "The URI of the source model in an Amazon S3 bucket. The model package must be in `tar.gz` or `.zip` format." }, "AWS::Greengrass::ResourceDefinition SageMakerMachineLearningModelResourceData": { "DestinationPath": "The absolute local path of the resource inside the Lambda environment.", - "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "SageMakerJobArn": "The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model." }, "AWS::Greengrass::ResourceDefinition SecretsManagerSecretResourceData": { @@ -15714,12 +15790,12 @@ }, "AWS::Greengrass::ResourceDefinitionVersion S3MachineLearningModelResourceData": { "DestinationPath": "The absolute local path of the resource inside the Lambda environment.", - "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "S3Uri": "The URI of the source model in an Amazon S3 bucket. The model package must be in `tar.gz` or `.zip` format." }, "AWS::Greengrass::ResourceDefinitionVersion SageMakerMachineLearningModelResourceData": { "DestinationPath": "The absolute local path of the resource inside the Lambda environment.", - "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "OwnerSetting": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "SageMakerJobArn": "The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model." }, "AWS::Greengrass::ResourceDefinitionVersion SecretsManagerSecretResourceData": { @@ -15729,7 +15805,7 @@ "AWS::Greengrass::SubscriptionDefinition": { "InitialVersion": "The subscription definition version to include when the subscription definition is created. A subscription definition version contains a list of [`subscription`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-subscriptiondefinition-subscription.html) property types.\n\n> To associate a subscription definition version after the subscription definition is created, create an [`AWS::Greengrass::SubscriptionDefinitionVersion`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinitionversion.html) resource and specify the ID of this subscription definition.", "Name": "The name of the subscription definition.", - "Tags": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" + "Tags": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```" }, "AWS::Greengrass::SubscriptionDefinition Subscription": { "Id": "A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with pattern `[a-zA-Z0-9:_-]+` .", @@ -16823,7 +16899,7 @@ "PerformanceScoreThreshold": "The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event." }, "AWS::InternetMonitor::Monitor InternetMeasurementsLogDelivery": { - "S3Config": "The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3." + "S3Config": "The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` or `DISABLED` , depending on whether you choose to deliver internet measurements to S3 logs." }, "AWS::InternetMonitor::Monitor LocalHealthEventsConfig": { "HealthScoreThreshold": "The health event threshold percentage set for a local health score.", @@ -16831,9 +16907,9 @@ "Status": "The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be `ENABLED` or `DISABLED` ." }, "AWS::InternetMonitor::Monitor S3Config": { - "BucketName": "The Amazon S3 bucket name for internet measurements publishing.", - "BucketPrefix": "An optional Amazon S3 bucket prefix for internet measurements publishing.", - "LogDeliveryStatus": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise." + "BucketName": "The Amazon S3 bucket name.", + "BucketPrefix": "The Amazon S3 bucket prefix.", + "LogDeliveryStatus": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket." }, "AWS::InternetMonitor::Monitor Tag": { "Key": "", @@ -17235,20 +17311,20 @@ "Value": "The tag's value." }, "AWS::IoT::SoftwarePackage": { - "Description": "", - "PackageName": "", - "Tags": "" + "Description": "A summary of the package being created. This can be used to outline the package's contents or purpose.", + "PackageName": "The name of the new software package.", + "Tags": "Metadata that can be used to manage the package." }, "AWS::IoT::SoftwarePackage Tag": { "Key": "The tag's key.", "Value": "The tag's value." }, "AWS::IoT::SoftwarePackageVersion": { - "Attributes": "", - "Description": "", - "PackageName": "", - "Tags": "", - "VersionName": "" + "Attributes": "Metadata that can be used to define a package version\u2019s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.\n\nThe combined size of all the attributes on a package version is limited to 3KB.", + "Description": "A summary of the package version being created. This can be used to outline the package's contents or purpose.", + "PackageName": "The name of the associated software package.", + "Tags": "Metadata that can be used to manage the package version.", + "VersionName": "The name of the new package version." }, "AWS::IoT::SoftwarePackageVersion Tag": { "Key": "The tag's key.", @@ -37821,21 +37897,52 @@ "Tags": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.\n\nTags that you specify for the Domain are also added to all apps that are launched in the Domain.\n\n*Array members* : Minimum number of 0 items. Maximum number of 50 items.", "VpcId": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.\n\n*Length Constraints* : Maximum length of 32.\n\n*Pattern* : `[-0-9a-zA-Z]+`" }, + "AWS::SageMaker::Domain CodeEditorAppSettings": { + "DefaultResourceSpec": "", + "LifecycleConfigArns": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration." + }, + "AWS::SageMaker::Domain CodeRepository": { + "RepositoryUrl": "The URL of the Git repository." + }, + "AWS::SageMaker::Domain CustomFileSystemConfig": { + "EFSFileSystemConfig": "The settings for a custom Amazon EFS file system." + }, "AWS::SageMaker::Domain CustomImage": { "AppImageConfigName": "The name of the AppImageConfig.", "ImageName": "The name of the CustomImage. Must be unique to your account.", "ImageVersionNumber": "The version number of the CustomImage." }, + "AWS::SageMaker::Domain CustomPosixUserConfig": { + "Gid": "The POSIX group ID.", + "Uid": "The POSIX user ID." + }, + "AWS::SageMaker::Domain DefaultEbsStorageSettings": { + "DefaultEbsVolumeSizeInGb": "The default size of the EBS storage volume for a private space.", + "MaximumEbsVolumeSizeInGb": "The maximum size of the EBS storage volume for a private space." + }, "AWS::SageMaker::Domain DefaultSpaceSettings": { "ExecutionRole": "The ARN of the execution role for the space.", "JupyterServerAppSettings": "The JupyterServer app settings.", "KernelGatewayAppSettings": "The KernelGateway app settings.", "SecurityGroups": "The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication." }, + "AWS::SageMaker::Domain DefaultSpaceStorageSettings": { + "DefaultEbsStorageSettings": "The default EBS storage settings for a private space." + }, "AWS::SageMaker::Domain DomainSettings": { "RStudioServerProDomainSettings": "A collection of settings that configure the `RStudioServerPro` Domain-level app.", "SecurityGroupIds": "The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain-level apps and user apps." }, + "AWS::SageMaker::Domain EFSFileSystemConfig": { + "FileSystemId": "The ID of your Amazon EFS file system.", + "FileSystemPath": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below." + }, + "AWS::SageMaker::Domain JupyterLabAppSettings": { + "CodeRepositories": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "CustomImages": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "DefaultResourceSpec": "", + "LifecycleConfigArns": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list." + }, "AWS::SageMaker::Domain JupyterServerAppSettings": { "DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app." }, @@ -37873,13 +37980,20 @@ "Value": "The tag value." }, "AWS::SageMaker::Domain UserSettings": { + "CodeEditorAppSettings": "The Code Editor application settings.", + "CustomFileSystemConfigs": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "CustomPosixUserConfig": "Details about the POSIX identity that is used for file system operations.", + "DefaultLandingUri": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", "ExecutionRole": "The execution role for the user.", + "JupyterLabAppSettings": "The settings for the JupyterLab application.", "JupyterServerAppSettings": "The Jupyter server's app settings.", "KernelGatewayAppSettings": "The kernel gateway app settings.", "RSessionAppSettings": "A collection of settings that configure the `RSessionGateway` app.", "RStudioServerProAppSettings": "A collection of settings that configure user interaction with the `RStudioServerPro` app.", "SecurityGroups": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.\n\nOptional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` .\n\nRequired when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` , unless specified as part of the `DefaultUserSettings` for the domain.\n\nAmazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.", - "SharingSettings": "Specifies options for sharing Amazon SageMaker Studio notebooks." + "SharingSettings": "Specifies options for sharing Amazon SageMaker Studio notebooks.", + "SpaceStorageSettings": "The storage settings for a private space.", + "StudioWebPortal": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain." }, "AWS::SageMaker::Endpoint": { "DeploymentConfig": "The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.", @@ -39146,11 +39260,42 @@ "UserProfileName": "The user profile name.", "UserSettings": "A collection of settings that apply to users of Amazon SageMaker Studio." }, + "AWS::SageMaker::UserProfile CodeEditorAppSettings": { + "DefaultResourceSpec": "", + "LifecycleConfigArns": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration." + }, + "AWS::SageMaker::UserProfile CodeRepository": { + "RepositoryUrl": "The URL of the Git repository." + }, + "AWS::SageMaker::UserProfile CustomFileSystemConfig": { + "EFSFileSystemConfig": "The settings for a custom Amazon EFS file system." + }, "AWS::SageMaker::UserProfile CustomImage": { "AppImageConfigName": "The name of the AppImageConfig.", "ImageName": "The name of the CustomImage. Must be unique to your account.", "ImageVersionNumber": "The version number of the CustomImage." }, + "AWS::SageMaker::UserProfile CustomPosixUserConfig": { + "Gid": "The POSIX group ID.", + "Uid": "The POSIX user ID." + }, + "AWS::SageMaker::UserProfile DefaultEbsStorageSettings": { + "DefaultEbsVolumeSizeInGb": "The default size of the EBS storage volume for a private space.", + "MaximumEbsVolumeSizeInGb": "The maximum size of the EBS storage volume for a private space." + }, + "AWS::SageMaker::UserProfile DefaultSpaceStorageSettings": { + "DefaultEbsStorageSettings": "The default EBS storage settings for a private space." + }, + "AWS::SageMaker::UserProfile EFSFileSystemConfig": { + "FileSystemId": "The ID of your Amazon EFS file system.", + "FileSystemPath": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below." + }, + "AWS::SageMaker::UserProfile JupyterLabAppSettings": { + "CodeRepositories": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "CustomImages": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "DefaultResourceSpec": "", + "LifecycleConfigArns": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list." + }, "AWS::SageMaker::UserProfile JupyterServerAppSettings": { "DefaultResourceSpec": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app." }, @@ -39177,12 +39322,19 @@ "Value": "The tag value." }, "AWS::SageMaker::UserProfile UserSettings": { + "CodeEditorAppSettings": "The Code Editor application settings.", + "CustomFileSystemConfigs": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "CustomPosixUserConfig": "Details about the POSIX identity that is used for file system operations.", + "DefaultLandingUri": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", "ExecutionRole": "The execution role for the user.", + "JupyterLabAppSettings": "The settings for the JupyterLab application.", "JupyterServerAppSettings": "The Jupyter server's app settings.", "KernelGatewayAppSettings": "The kernel gateway app settings.", "RStudioServerProAppSettings": "A collection of settings that configure user interaction with the `RStudioServerPro` app.", "SecurityGroups": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.\n\nOptional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly` .\n\nRequired when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly` , unless specified as part of the `DefaultUserSettings` for the domain.\n\nAmazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.", - "SharingSettings": "Specifies options for sharing Amazon SageMaker Studio notebooks." + "SharingSettings": "Specifies options for sharing Amazon SageMaker Studio notebooks.", + "SpaceStorageSettings": "The storage settings for a private space.", + "StudioWebPortal": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain." }, "AWS::SageMaker::Workteam": { "Description": "A description of the work team.", diff --git a/schema_source/cloudformation.schema.json b/schema_source/cloudformation.schema.json index 50e74cdc3..933820b90 100644 --- a/schema_source/cloudformation.schema.json +++ b/schema_source/cloudformation.schema.json @@ -24294,24 +24294,36 @@ "additionalProperties": false, "properties": { "BusinessName": { + "markdownDescription": "Returns the name for the business associated with this profile.", + "title": "BusinessName", "type": "string" }, "Email": { + "markdownDescription": "", + "title": "Email", "type": "string" }, "Logging": { + "markdownDescription": "Specifies whether or not logging is enabled for this profile.", + "title": "Logging", "type": "string" }, "Name": { + "markdownDescription": "Returns the display name for profile.", + "title": "Name", "type": "string" }, "Phone": { + "markdownDescription": "", + "title": "Phone", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A key-value pair for a specific profile. Tags are metadata that you can use to search for and group capabilities for various purposes.", + "title": "Tags", "type": "array" } }, @@ -24380,30 +24392,46 @@ "additionalProperties": false, "properties": { "EdiType": { - "$ref": "#/definitions/AWS::B2BI::Transformer.EdiType" + "$ref": "#/definitions/AWS::B2BI::Transformer.EdiType", + "markdownDescription": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.", + "title": "EdiType" }, "FileFormat": { + "markdownDescription": "Returns that the currently supported file formats for EDI transformations are `JSON` and `XML` .", + "title": "FileFormat", "type": "string" }, "MappingTemplate": { + "markdownDescription": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "title": "MappingTemplate", "type": "string" }, "ModifiedAt": { + "markdownDescription": "Returns a timestamp representing the date and time for the most recent change for the transformer object.", + "title": "ModifiedAt", "type": "string" }, "Name": { + "markdownDescription": "Returns the descriptive name for the transformer.", + "title": "Name", "type": "string" }, "SampleDocument": { + "markdownDescription": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.", + "title": "SampleDocument", "type": "string" }, "Status": { + "markdownDescription": "Returns the state of the newly created transformer. The transformer can be either `active` or `inactive` . For the transformer to be used in a capability, its status must `active` .", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A key-value pair for a specific transformer. Tags are metadata that you can use to search for and group capabilities for various purposes.", + "title": "Tags", "type": "array" } }, @@ -24441,7 +24469,9 @@ "additionalProperties": false, "properties": { "X12Details": { - "$ref": "#/definitions/AWS::B2BI::Transformer.X12Details" + "$ref": "#/definitions/AWS::B2BI::Transformer.X12Details", + "markdownDescription": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.", + "title": "X12Details" } }, "required": [ @@ -24453,9 +24483,13 @@ "additionalProperties": false, "properties": { "TransactionSet": { + "markdownDescription": "Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.", + "title": "TransactionSet", "type": "string" }, "Version": { + "markdownDescription": "Returns the version to use for the specified X12 transaction set. Supported versions are `4010` , `4030` , and `5010` .", + "title": "Version", "type": "string" } }, @@ -30848,7 +30882,7 @@ "type": "string" }, "ImageId": { - "markdownDescription": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (default): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (default): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", + "markdownDescription": "The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.\n\nFrom December 04, 2023, you will be required to include the `imageId` parameter for the `CreateEnvironmentEC2` action. This change will be reflected across all direct methods of communicating with the API, such as AWS SDK, AWS CLI and AWS CloudFormation. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nFrom January 22, 2024, Amazon Linux (AL1) will be removed from the list of available image IDs for Cloud9. This is necessary as AL1 will reach the end of maintenance support in December 2023, and as a result will no longer receive security updates. We recommend using Amazon Linux 2023 as the new AMI to create your environment as it is fully supported. This change will only affect direct API consumers, and not AWS Cloud9 console users.\n\nSince Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend you choose Ubuntu 22.04.\n\n*AMI aliases*\n\n- Amazon Linux (end of maintenance support December 2023): `amazonlinux-1-x86_64`\n- Amazon Linux 2: `amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `ubuntu-22.04-x86_64`\n\n*SSM paths*\n\n- Amazon Linux (end of maintenance support December 2023): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`\n- Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n- Amazon Linux 2023 (recommended): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64`\n- Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n- Ubuntu 22.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64`", "title": "ImageId", "type": "string" }, @@ -36052,7 +36086,7 @@ "type": "array" }, "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .\n\n> Only the management account can configure a CloudWatch Logs log group for an organization trail.", + "markdownDescription": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. You must use a log group that exists in your account.\n\nNot required unless you specify `CloudWatchLogsRoleArn` .", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, @@ -46540,7 +46574,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" }, @@ -47308,7 +47342,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -47421,7 +47455,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -47617,7 +47651,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -48182,7 +48216,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", + "markdownDescription": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.", "title": "Tags", "type": "array" } @@ -57661,7 +57695,7 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.", + "markdownDescription": "Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.\n\nIf you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.", "title": "Domain", "type": "string" }, @@ -57865,7 +57899,7 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "markdownDescription": "Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.", "title": "Domain", "type": "string" }, @@ -57875,7 +57909,7 @@ "type": "string" }, "Password": { - "markdownDescription": "Specifies the password of the user who has the permissions to access files and folders in the file system.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) for FSx for Windows File Server locations.", + "markdownDescription": "Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.", "title": "Password", "type": "string" }, @@ -58491,7 +58525,7 @@ "type": "array" }, "Domain": { - "markdownDescription": "Specifies the Windows domain name that your SMB file server belongs to.\n\nIf you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.\n\nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations.", + "markdownDescription": "Specifies the name of the Active Directory domain that your SMB file server belongs to.\n\nIf you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.", "title": "Domain", "type": "string" }, @@ -58890,7 +58924,7 @@ "type": "string" }, "LogLevel": { - "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\nIf you set `LogLevel` to `OFF` , no logs are published. `BASIC` publishes logs on errors for individual files transferred. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked.", + "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn) .\n\n- `BASIC` - Publishes logs with only basic information (such as transfer errors).\n- `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.\n- `OFF` - No logs are published.", "title": "LogLevel", "type": "string" }, @@ -58900,7 +58934,7 @@ "type": "string" }, "ObjectTags": { - "markdownDescription": "Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.\n\nDefault Value: `PRESERVE`", + "markdownDescription": "Specifies whether you want DataSync to `PRESERVE` object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.", "title": "ObjectTags", "type": "string" }, @@ -91099,7 +91133,7 @@ "properties": { "CloudWatchLogsConfiguration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration", - "markdownDescription": "The configuration for experiment logging to CloudWatch Logs .", + "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs.", "title": "CloudWatchLogsConfiguration" }, "LogSchemaVersion": { @@ -91109,7 +91143,7 @@ }, "S3Configuration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.S3Configuration", - "markdownDescription": "The configuration for experiment logging to Amazon S3 .", + "markdownDescription": "The configuration for experiment logging to Amazon S3.", "title": "S3Configuration" } }, @@ -91150,7 +91184,7 @@ }, "Parameters": { "additionalProperties": true, - "markdownDescription": "The parameters for the resource type.", + "markdownDescription": "The resource type parameters.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -100503,7 +100537,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the connector definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -100538,7 +100572,7 @@ "additionalProperties": false, "properties": { "ConnectorArn": { - "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "ConnectorArn", "type": "string" }, @@ -100548,7 +100582,7 @@ "type": "string" }, "Parameters": { - "markdownDescription": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The parameters or configuration used by the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "Parameters", "type": "object" } @@ -100656,7 +100690,7 @@ "additionalProperties": false, "properties": { "ConnectorArn": { - "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The Amazon Resource Name (ARN) of the connector.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "ConnectorArn", "type": "string" }, @@ -100666,7 +100700,7 @@ "type": "string" }, "Parameters": { - "markdownDescription": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-list.html) .", + "markdownDescription": "The parameters or configuration that the connector uses.\n\nFor more information about connectors provided by AWS , see [Greengrass Connectors Provided by AWS](https://docs.aws.amazon.com/greengrass/v1/developerguide/connectors-list.html) .", "title": "Parameters", "type": "object" } @@ -100723,7 +100757,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the core definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -100955,7 +100989,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the device definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101187,7 +101221,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the function definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101265,13 +101299,13 @@ "additionalProperties": false, "properties": { "IsolationMode": { - "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "title": "IsolationMode", "type": "string" }, "RunAs": { "$ref": "#/definitions/AWS::Greengrass::FunctionDefinition.RunAs", - "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .", + "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) .", "title": "RunAs" } }, @@ -101529,13 +101563,13 @@ "additionalProperties": false, "properties": { "IsolationMode": { - "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", + "markdownDescription": "The containerization that the Lambda function runs in. Valid values are `GreengrassContainer` or `NoContainer` . Typically, this is `GreengrassContainer` . For more information, see [Containerization](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-function-containerization) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default containerization for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. Omit this value to run the function with the default containerization.\n\n> We recommend that you run in a Greengrass container unless your business case requires that you run without containerization.", "title": "IsolationMode", "type": "string" }, "RunAs": { "$ref": "#/definitions/AWS::Greengrass::FunctionDefinitionVersion.RunAs", - "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-group-config.html#lambda-running-as-root) .", + "markdownDescription": "The user and group permissions used to run the Lambda function. Typically, this is the ggc_user and ggc_group. For more information, see [Run as](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-access-identity.html) in the *Developer Guide* .\n\n- When set on the [`DefaultConfig`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-defaultconfig.html) property of a function definition version, this setting is used as the default access identity for all Lambda functions in the function definition version.\n- When set on the [`Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-functiondefinitionversion-environment.html) property of a function, this setting applies to the individual function and overrides the default. You can override the user, group, or both. Omit this value to run the function with the default permissions.\n\n> Running as the root user increases risks to your data and device. Do not run as root (UID/GID=0) unless your business case requires it. For more information and requirements, see [Running a Lambda Function as Root](https://docs.aws.amazon.com/greengrass/v1/developerguide/lambda-group-config.html#lambda-running-as-root) .", "title": "RunAs" } }, @@ -101694,7 +101728,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the group. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -101914,7 +101948,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the logger definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -102158,7 +102192,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the resource definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -102356,7 +102390,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "S3Uri": { @@ -102381,7 +102415,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinition.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "SageMakerJobArn": { @@ -102644,7 +102678,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "S3Uri": { @@ -102669,7 +102703,7 @@ }, "OwnerSetting": { "$ref": "#/definitions/AWS::Greengrass::ResourceDefinitionVersion.ResourceDownloadOwnerSetting", - "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-ml-resources.html) in the *Developer Guide* .", + "markdownDescription": "The owner setting for the downloaded machine learning resource. For more information, see [Access Machine Learning Resources from Lambda Functions](https://docs.aws.amazon.com/greengrass/v1/developerguide/access-ml-resources.html) in the *Developer Guide* .", "title": "OwnerSetting" }, "SageMakerJobArn": { @@ -102752,7 +102786,7 @@ "type": "string" }, "Tags": { - "markdownDescription": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", + "markdownDescription": "Application-specific metadata to attach to the subscription definition. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see [Tagging Your AWS IoT Greengrass Resources](https://docs.aws.amazon.com/greengrass/v1/developerguide/tagging.html) in the *Developer Guide* .\n\nThis `Json` property type is processed as a map of key-value pairs. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates.\n\n```json\n\"Tags\": { \"KeyName0\": \"value\", \"KeyName1\": \"value\", \"KeyName2\": \"value\"\n}\n```", "title": "Tags", "type": "object" } @@ -110630,7 +110664,7 @@ "properties": { "S3Config": { "$ref": "#/definitions/AWS::InternetMonitor::Monitor.S3Config", - "markdownDescription": "The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.", + "markdownDescription": "The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` or `DISABLED` , depending on whether you choose to deliver internet measurements to S3 logs.", "title": "S3Config" } }, @@ -110661,17 +110695,17 @@ "additionalProperties": false, "properties": { "BucketName": { - "markdownDescription": "The Amazon S3 bucket name for internet measurements publishing.", + "markdownDescription": "The Amazon S3 bucket name.", "title": "BucketName", "type": "string" }, "BucketPrefix": { - "markdownDescription": "An optional Amazon S3 bucket prefix for internet measurements publishing.", + "markdownDescription": "The Amazon S3 bucket prefix.", "title": "BucketPrefix", "type": "string" }, "LogDeliveryStatus": { - "markdownDescription": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise.", + "markdownDescription": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.", "title": "LogDeliveryStatus", "type": "string" } @@ -113577,12 +113611,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "", + "markdownDescription": "A summary of the package being created. This can be used to outline the package's contents or purpose.", "title": "Description", "type": "string" }, "PackageName": { - "markdownDescription": "", + "markdownDescription": "The name of the new software package.", "title": "PackageName", "type": "string" }, @@ -113590,7 +113624,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to manage the package.", "title": "Tags", "type": "array" } @@ -113654,7 +113688,7 @@ "properties": { "Attributes": { "additionalProperties": true, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to define a package version\u2019s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.\n\nThe combined size of all the attributes on a package version is limited to 3KB.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -113664,12 +113698,12 @@ "type": "object" }, "Description": { - "markdownDescription": "", + "markdownDescription": "A summary of the package version being created. This can be used to outline the package's contents or purpose.", "title": "Description", "type": "string" }, "PackageName": { - "markdownDescription": "", + "markdownDescription": "The name of the associated software package.", "title": "PackageName", "type": "string" }, @@ -113677,12 +113711,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "", + "markdownDescription": "Metadata that can be used to manage the package version.", "title": "Tags", "type": "array" }, "VersionName": { - "markdownDescription": "", + "markdownDescription": "The name of the new package version.", "title": "VersionName", "type": "string" } @@ -232783,12 +232817,16 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -232798,6 +232836,8 @@ "additionalProperties": false, "properties": { "RepositoryUrl": { + "markdownDescription": "The URL of the Git repository.", + "title": "RepositoryUrl", "type": "string" } }, @@ -232810,7 +232850,9 @@ "additionalProperties": false, "properties": { "EFSFileSystemConfig": { - "$ref": "#/definitions/AWS::SageMaker::Domain.EFSFileSystemConfig" + "$ref": "#/definitions/AWS::SageMaker::Domain.EFSFileSystemConfig", + "markdownDescription": "The settings for a custom Amazon EFS file system.", + "title": "EFSFileSystemConfig" } }, "type": "object" @@ -232844,9 +232886,13 @@ "additionalProperties": false, "properties": { "Gid": { + "markdownDescription": "The POSIX group ID.", + "title": "Gid", "type": "number" }, "Uid": { + "markdownDescription": "The POSIX user ID.", + "title": "Uid", "type": "number" } }, @@ -232860,9 +232906,13 @@ "additionalProperties": false, "properties": { "DefaultEbsVolumeSizeInGb": { + "markdownDescription": "The default size of the EBS storage volume for a private space.", + "title": "DefaultEbsVolumeSizeInGb", "type": "number" }, "MaximumEbsVolumeSizeInGb": { + "markdownDescription": "The maximum size of the EBS storage volume for a private space.", + "title": "MaximumEbsVolumeSizeInGb", "type": "number" } }, @@ -232908,7 +232958,9 @@ "additionalProperties": false, "properties": { "DefaultEbsStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultEbsStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultEbsStorageSettings", + "markdownDescription": "The default EBS storage settings for a private space.", + "title": "DefaultEbsStorageSettings" } }, "type": "object" @@ -232936,9 +232988,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The ID of your Amazon EFS file system.", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.", + "title": "FileSystemPath", "type": "string" } }, @@ -232954,21 +233010,29 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CodeRepository" }, + "markdownDescription": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "title": "CodeRepositories", "type": "array" }, "CustomImages": { "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -233119,18 +233183,26 @@ "additionalProperties": false, "properties": { "CodeEditorAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.CodeEditorAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.CodeEditorAppSettings", + "markdownDescription": "The Code Editor application settings.", + "title": "CodeEditorAppSettings" }, "CustomFileSystemConfigs": { "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomFileSystemConfig" }, + "markdownDescription": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "title": "CustomFileSystemConfigs", "type": "array" }, "CustomPosixUserConfig": { - "$ref": "#/definitions/AWS::SageMaker::Domain.CustomPosixUserConfig" + "$ref": "#/definitions/AWS::SageMaker::Domain.CustomPosixUserConfig", + "markdownDescription": "Details about the POSIX identity that is used for file system operations.", + "title": "CustomPosixUserConfig" }, "DefaultLandingUri": { + "markdownDescription": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", + "title": "DefaultLandingUri", "type": "string" }, "ExecutionRole": { @@ -233139,7 +233211,9 @@ "type": "string" }, "JupyterLabAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterLabAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterLabAppSettings", + "markdownDescription": "The settings for the JupyterLab application.", + "title": "JupyterLabAppSettings" }, "JupyterServerAppSettings": { "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings", @@ -233175,9 +233249,13 @@ "title": "SharingSettings" }, "SpaceStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceStorageSettings", + "markdownDescription": "The storage settings for a private space.", + "title": "SpaceStorageSettings" }, "StudioWebPortal": { + "markdownDescription": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain.", + "title": "StudioWebPortal", "type": "string" } }, @@ -240292,12 +240370,16 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the Code Editor application lifecycle configuration.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -240307,6 +240389,8 @@ "additionalProperties": false, "properties": { "RepositoryUrl": { + "markdownDescription": "The URL of the Git repository.", + "title": "RepositoryUrl", "type": "string" } }, @@ -240319,7 +240403,9 @@ "additionalProperties": false, "properties": { "EFSFileSystemConfig": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.EFSFileSystemConfig" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.EFSFileSystemConfig", + "markdownDescription": "The settings for a custom Amazon EFS file system.", + "title": "EFSFileSystemConfig" } }, "type": "object" @@ -240353,9 +240439,13 @@ "additionalProperties": false, "properties": { "Gid": { + "markdownDescription": "The POSIX group ID.", + "title": "Gid", "type": "number" }, "Uid": { + "markdownDescription": "The POSIX user ID.", + "title": "Uid", "type": "number" } }, @@ -240369,9 +240459,13 @@ "additionalProperties": false, "properties": { "DefaultEbsVolumeSizeInGb": { + "markdownDescription": "The default size of the EBS storage volume for a private space.", + "title": "DefaultEbsVolumeSizeInGb", "type": "number" }, "MaximumEbsVolumeSizeInGb": { + "markdownDescription": "The maximum size of the EBS storage volume for a private space.", + "title": "MaximumEbsVolumeSizeInGb", "type": "number" } }, @@ -240385,7 +240479,9 @@ "additionalProperties": false, "properties": { "DefaultEbsStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultEbsStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultEbsStorageSettings", + "markdownDescription": "The default EBS storage settings for a private space.", + "title": "DefaultEbsStorageSettings" } }, "type": "object" @@ -240394,9 +240490,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The ID of your Amazon EFS file system.", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "The path to the file system directory that is accessible in Amazon SageMaker Studio. Permitted users can access only this directory and below.", + "title": "FileSystemPath", "type": "string" } }, @@ -240412,21 +240512,29 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeRepository" }, + "markdownDescription": "A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.", + "title": "CodeRepositories", "type": "array" }, "CustomImages": { "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a JupyterLab app.", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.ResourceSpec", + "markdownDescription": "", + "title": "DefaultResourceSpec" }, "LifecycleConfigArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set `LifecycleConfigArns` to an empty list.", + "title": "LifecycleConfigArns", "type": "array" } }, @@ -240524,18 +240632,26 @@ "additionalProperties": false, "properties": { "CodeEditorAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeEditorAppSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.CodeEditorAppSettings", + "markdownDescription": "The Code Editor application settings.", + "title": "CodeEditorAppSettings" }, "CustomFileSystemConfigs": { "items": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomFileSystemConfig" }, + "markdownDescription": "The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.", + "title": "CustomFileSystemConfigs", "type": "array" }, "CustomPosixUserConfig": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomPosixUserConfig" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.CustomPosixUserConfig", + "markdownDescription": "Details about the POSIX identity that is used for file system operations.", + "title": "CustomPosixUserConfig" }, "DefaultLandingUri": { + "markdownDescription": "The default experience that the user is directed to when accessing the domain. The supported values are:\n\n- `studio::` : Indicates that Studio is the default experience. This value can only be passed if `StudioWebPortal` is set to `ENABLED` .\n- `app:JupyterServer:` : Indicates that Studio Classic is the default experience.", + "title": "DefaultLandingUri", "type": "string" }, "ExecutionRole": { @@ -240544,7 +240660,9 @@ "type": "string" }, "JupyterLabAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterLabAppSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterLabAppSettings", + "markdownDescription": "The settings for the JupyterLab application.", + "title": "JupyterLabAppSettings" }, "JupyterServerAppSettings": { "$ref": "#/definitions/AWS::SageMaker::UserProfile.JupyterServerAppSettings", @@ -240575,9 +240693,13 @@ "title": "SharingSettings" }, "SpaceStorageSettings": { - "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings" + "$ref": "#/definitions/AWS::SageMaker::UserProfile.DefaultSpaceStorageSettings", + "markdownDescription": "The storage settings for a private space.", + "title": "SpaceStorageSettings" }, "StudioWebPortal": { + "markdownDescription": "Whether the user can access Studio. If this value is set to `DISABLED` , the user cannot access Studio, even if that is the default experience for the domain.", + "title": "StudioWebPortal", "type": "string" } },