Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(schema): update #3428

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions samtranslator/schema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -7104,7 +7104,7 @@
"additionalProperties": false,
"properties": {
"ApiId": {
"markdownDescription": "The identifier of the API.",
"markdownDescription": "The API identifier.",
"title": "ApiId",
"type": "string"
},
Expand Down Expand Up @@ -7665,13 +7665,9 @@
"additionalProperties": false,
"properties": {
"Destination": {
"markdownDescription": "Specifies the location of the response to modify, and how to modify it. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .",
"title": "Destination",
"type": "string"
},
"Source": {
"markdownDescription": "Specifies the data to update the parameter with. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .",
"title": "Source",
"type": "string"
}
},
Expand All @@ -7688,8 +7684,6 @@
"items": {
"$ref": "#/definitions/AWS::ApiGatewayV2::Integration.ResponseParameter"
},
"markdownDescription": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern `<action>:<header>.<location>` or `overwrite.statuscode` . The action can be `append` , `overwrite` or `remove` . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .",
"title": "ResponseParameters",
"type": "array"
}
},
Expand Down Expand Up @@ -30021,7 +30015,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 November 20, 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: `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: `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 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`",
"title": "ImageId",
"type": "string"
},
Expand Down Expand Up @@ -34847,7 +34841,7 @@
"type": "boolean"
},
"RetentionPeriod": {
"markdownDescription": "The retention period of the event data store, in days. You can set a retention period of up to 2557 days, the equivalent of seven years.",
"markdownDescription": "The retention period of the event data store, in days. If `BillingMode` is set to `EXTENDABLE_RETENTION_PRICING` , you can set a retention period of up to 3653 days, the equivalent of 10 years. If `BillingMode` is set to `FIXED_RETENTION_PRICING` , you can set a retention period of up to 2557 days, the equivalent of seven years.\n\nCloudTrail Lake determines whether to retain an event by checking if the `eventTime` of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the `eventTime` is older than 90 days.\n\n> If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.",
"title": "RetentionPeriod",
"type": "number"
},
Expand Down Expand Up @@ -50195,12 +50189,12 @@
"type": "boolean"
},
"ExecutionHandler": {
"markdownDescription": "The SSM document that includes the pre and/or post scripts to run.\n\n- If you are automating VSS backups, specify `AWS_VSS_BACKUP` . In this case, Amazon Data Lifecycle Manager automatically uses the `AWSEC2-CreateVssSnapshot` SSM document.\n- If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.",
"markdownDescription": "The SSM document that includes the pre and/or post scripts to run.\n\n- If you are automating VSS backups, specify `AWS_VSS_BACKUP` . In this case, Amazon Data Lifecycle Manager automatically uses the `AWSEC2-CreateVssSnapshot` SSM document.\n- If you are automating application-consistent snapshots for SAP HANA workloads, specify `AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA` .\n- If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document.",
"title": "ExecutionHandler",
"type": "string"
},
"ExecutionHandlerService": {
"markdownDescription": "Indicates the service used to execute the pre and/or post scripts.\n\n- If you are using custom SSM documents, specify `AWS_SYSTEMS_MANAGER` .\n- If you are automating VSS Backups, omit this parameter.\n\nDefault: AWS_SYSTEMS_MANAGER",
"markdownDescription": "Indicates the service used to execute the pre and/or post scripts.\n\n- If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify `AWS_SYSTEMS_MANAGER` .\n- If you are automating VSS Backups, omit this parameter.\n\nDefault: AWS_SYSTEMS_MANAGER",
"title": "ExecutionHandlerService",
"type": "string"
},
Expand Down Expand Up @@ -61847,7 +61841,7 @@
"type": "array"
},
"Tier": {
"markdownDescription": "",
"markdownDescription": "IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see the [VPC IPAM product pricing page](https://docs.aws.amazon.com//vpc/pricing/) .",
"title": "Tier",
"type": "string"
}
Expand Down Expand Up @@ -86272,7 +86266,7 @@
"type": "string"
},
"State": {
"markdownDescription": "The state of the rule.",
"markdownDescription": "The state of the rule.\n\nValid values include:\n\n- `DISABLED` : The rule is disabled. EventBridge does not match any events against the rule.\n- `ENABLED` : The rule is enabled. EventBridge matches events against the rule, *except* for AWS management events delivered through CloudTrail.\n- `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` : The rule is enabled for all events, including AWS management events delivered through CloudTrail.\n\nManagement events provide visibility into management operations that are performed on resources in your AWS account. These are also known as control plane operations. For more information, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events) in the *CloudTrail User Guide* , and [Filtering management events from AWS services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail) in the *Amazon EventBridge User Guide* .\n\nThis value is only valid for rules on the [default](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses) event bus or [custom event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html) . It does not apply to [partner event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html) .",
"title": "State",
"type": "string"
},
Expand Down Expand Up @@ -93006,18 +93000,26 @@
"additionalProperties": false,
"properties": {
"Name": {
"markdownDescription": "A descriptive label that is associated with a script. Script names do not need to be unique.",
"title": "Name",
"type": "string"
},
"StorageLocation": {
"$ref": "#/definitions/AWS::GameLift::Script.S3Location"
"$ref": "#/definitions/AWS::GameLift::Script.S3Location",
"markdownDescription": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version.",
"title": "StorageLocation"
},
"Tags": {
"items": {
"$ref": "#/definitions/Tag"
},
"markdownDescription": "A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference* . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.",
"title": "Tags",
"type": "array"
},
"Version": {
"markdownDescription": "The version that is associated with a build or script. Version strings do not need to be unique.",
"title": "Version",
"type": "string"
}
},
Expand Down Expand Up @@ -93051,15 +93053,23 @@
"additionalProperties": false,
"properties": {
"Bucket": {
"markdownDescription": "An Amazon S3 bucket identifier. Thename of the S3 bucket.\n\n> Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).",
"title": "Bucket",
"type": "string"
},
"Key": {
"markdownDescription": "The name of the zip file that contains the build files or script files.",
"title": "Key",
"type": "string"
},
"ObjectVersion": {
"markdownDescription": "The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.",
"title": "ObjectVersion",
"type": "string"
},
"RoleArn": {
"markdownDescription": "The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) for an IAM role that allows Amazon GameLift to access the S3 bucket.",
"title": "RoleArn",
"type": "string"
}
},
Expand Down Expand Up @@ -101335,12 +101345,12 @@
"additionalProperties": false,
"properties": {
"Key": {
"markdownDescription": "",
"markdownDescription": "The tag value.",
"title": "Key",
"type": "string"
},
"Value": {
"markdownDescription": "",
"markdownDescription": "The tag key.",
"title": "Value",
"type": "string"
}
Expand Down Expand Up @@ -107225,13 +107235,9 @@
"additionalProperties": false,
"properties": {
"CallbackOverrides": {
"markdownDescription": "An optional AWS Lambda function to invoke instead of the default AWS Lambda function provided by the placement template.",
"title": "CallbackOverrides",
"type": "object"
},
"DeviceType": {
"markdownDescription": "The device type, which currently must be `\"button\"` .",
"title": "DeviceType",
"type": "string"
}
},
Expand Down Expand Up @@ -242937,7 +242943,7 @@
"type": "string"
},
"Target": {
"markdownDescription": "Represents the map target that is used in a `HomeDirectorymapEntry` .",
"markdownDescription": "Represents the map target that is used in a `HomeDirectoryMapEntry` .",
"title": "Target",
"type": "string"
}
Expand Down
Loading