diff --git a/CHANGELOG.md b/CHANGELOG.md
index f85ba3907cf..c5a8b4a85d9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,23 @@
+Release v1.38.67 (2021-06-24)
+===
+
+### Service Client Updates
+* `service/chime`: Updates service API and documentation
+ * Adds EventIngestionUrl field to MediaPlacement
+* `service/cloud9`: Updates service documentation and examples
+ * Minor update to AWS Cloud9 documentation to allow correct parsing of outputted text
+* `service/codebuild`: Updates service API and documentation
+ * BucketOwnerAccess is currently not supported
+* `service/connect`: Updates service API and documentation
+* `service/dax`: Updates service API and documentation
+ * Add support for encryption in transit to DAX clusters.
+* `service/kendra`: Updates service API and documentation
+ * Amazon Kendra now supports SharePoint 2013 and SharePoint 2016 when using a SharePoint data source.
+* `service/securityhub`: Updates service API and documentation
+* `service/transfer`: Updates service API and documentation
+ * Customers can successfully use legacy clients with Transfer Family endpoints enabled for FTPS and FTP behind routers, firewalls, and load balancers by providing a Custom IP address used for data channel communication.
+* `service/wafv2`: Updates service API and documentation
+
Release v1.38.66 (2021-06-23)
===
diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go
index cef754e1ae4..b5fb6dd0f8f 100644
--- a/aws/endpoints/defaults.go
+++ b/aws/endpoints/defaults.go
@@ -4891,6 +4891,7 @@ var awsPartition = partition{
"ap-east-1": endpoint{},
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
+ "ap-northeast-3": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
@@ -9626,6 +9627,18 @@ var awsusgovPartition = partition{
"mq": service{
Endpoints: endpoints{
+ "fips-us-gov-east-1": endpoint{
+ Hostname: "mq-fips.us-gov-east-1.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-gov-east-1",
+ },
+ },
+ "fips-us-gov-west-1": endpoint{
+ Hostname: "mq-fips.us-gov-west-1.amazonaws.com",
+ CredentialScope: credentialScope{
+ Region: "us-gov-west-1",
+ },
+ },
"us-gov-east-1": endpoint{},
"us-gov-west-1": endpoint{},
},
diff --git a/aws/version.go b/aws/version.go
index 0b5f25f0d8b..dfd25e923b4 100644
--- a/aws/version.go
+++ b/aws/version.go
@@ -5,4 +5,4 @@ package aws
const SDKName = "aws-sdk-go"
// SDKVersion is the version of this SDK
-const SDKVersion = "1.38.66"
+const SDKVersion = "1.38.67"
diff --git a/models/apis/chime/2018-05-01/api-2.json b/models/apis/chime/2018-05-01/api-2.json
index 3dd5380c143..935d97c1ecc 100644
--- a/models/apis/chime/2018-05-01/api-2.json
+++ b/models/apis/chime/2018-05-01/api-2.json
@@ -7242,7 +7242,8 @@
"ScreenSharingUrl":{"shape":"UriType"},
"ScreenViewingUrl":{"shape":"UriType"},
"SignalingUrl":{"shape":"UriType"},
- "TurnControlUrl":{"shape":"UriType"}
+ "TurnControlUrl":{"shape":"UriType"},
+ "EventIngestionUrl":{"shape":"UriType"}
}
},
"Meeting":{
diff --git a/models/apis/chime/2018-05-01/docs-2.json b/models/apis/chime/2018-05-01/docs-2.json
index cd65a732f27..8fdf50a7cfb 100644
--- a/models/apis/chime/2018-05-01/docs-2.json
+++ b/models/apis/chime/2018-05-01/docs-2.json
@@ -11,7 +11,7 @@
"BatchCreateRoomMembership": "
Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
",
"BatchDeletePhoneNumber": "
Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
",
"BatchSuspendUser": "
Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
",
- "BatchUnsuspendUser": "
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
",
+ "BatchUnsuspendUser": "
Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the account types, in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
",
"BatchUpdatePhoneNumber": "
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
",
"BatchUpdateUser": "
Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
",
"CreateAccount": "
Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
",
"GetAccount": "
Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
",
- "GetAccountSettings": "
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
",
+ "GetAccountSettings": "
Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
",
"GetAppInstanceRetentionSettings": "
Gets the retention settings for an AppInstance.
",
"GetAppInstanceStreamingConfigurations": "
Gets the streaming settings for an AppInstance.
",
"GetAttendee": "
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
",
@@ -92,7 +92,7 @@
"GetPhoneNumberOrder": "
Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
",
"GetPhoneNumberSettings": "
Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
",
"GetProxySession": "
Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
",
- "GetRetentionSettings": "
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
",
+ "GetRetentionSettings": "
Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
",
"GetRoom": "
Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
",
"GetSipMediaApplication": "
Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
Returns the logging configuration for the specified SIP media application.
",
@@ -114,7 +114,7 @@
"ListAppInstanceUsers": "
List all AppInstanceUsers created under a single AppInstance.
",
"ListAppInstances": "
Lists all Amazon Chime AppInstances created under a single AWS account.
",
"ListAttendeeTags": "
Lists the tags applied to an Amazon Chime SDK attendee resource.
",
- "ListAttendees": "
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
",
+ "ListAttendees": "
Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
",
"ListBots": "
Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
",
"ListChannelBans": "
Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
",
"ListChannelMemberships": "
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Updates the details of the specified SIP media application.
",
"UpdateSipMediaApplicationCall": "
Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.
",
"UpdateSipRule": "
Updates the details of the specified SIP rule.
",
- "UpdateUser": "
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
",
+ "UpdateUser": "
Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
",
"UpdateUserSettings": "
Updates the settings for the specified user, such as phone number settings.
",
"UpdateVoiceConnector": "
Updates details for the specified Amazon Chime Voice Connector.
",
"UpdateVoiceConnectorGroup": "
Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
Metadata that is associated with Amazon Web Services resources. In particular, a name-value pair that can be associated with an Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by Amazon Web Services services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
",
+ "base": "
Metadata that is associated with Amazon Web Services resources. In particular, a name-value pair that can be associated with an Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by Amazon Web Services services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.
",
"refs": {
"TagList$member": null
}
diff --git a/models/apis/cloud9/2017-09-23/examples-1.json b/models/apis/cloud9/2017-09-23/examples-1.json
index 92cc8bb00f2..fdef2700951 100644
--- a/models/apis/cloud9/2017-09-23/examples-1.json
+++ b/models/apis/cloud9/2017-09-23/examples-1.json
@@ -115,7 +115,7 @@
"output": {
}
},
- "description": "The following example gets information about all of the environment members for the specified &AWS; Cloud9 development environment.",
+ "description": "The following example gets information about all of the environment members for the specified development environment.",
"id": "describeenvironmentmemberships1-1516823070453",
"title": "DescribeEnvironmentMemberships1"
},
@@ -142,7 +142,7 @@
"output": {
}
},
- "description": "The following example gets information about the owner of the specified &AWS; Cloud9 development environment.",
+ "description": "The following example gets information about the owner of the specified development environment.",
"id": "describeenvironmentmemberships2-1516823191355",
"title": "DescribeEnvironmentMemberships2"
},
@@ -174,7 +174,7 @@
"output": {
}
},
- "description": "The following example gets &AWS; Cloud9 development environment membership information for the specified user.",
+ "description": "The following example gets development environment membership information for the specified user.",
"id": "describeenvironmentmemberships3-1516823268793",
"title": "DescribeEnvironmentMemberships3"
}
diff --git a/models/apis/codebuild/2016-10-06/api-2.json b/models/apis/codebuild/2016-10-06/api-2.json
index 343ea5861e7..2d6916d4572 100644
--- a/models/apis/codebuild/2016-10-06/api-2.json
+++ b/models/apis/codebuild/2016-10-06/api-2.json
@@ -699,14 +699,6 @@
}
},
"Boolean":{"type":"boolean"},
- "BucketOwnerAccess":{
- "type":"string",
- "enum":[
- "NONE",
- "READ_ONLY",
- "FULL"
- ]
- },
"Build":{
"type":"structure",
"members":{
@@ -752,8 +744,7 @@
"md5sum":{"shape":"String"},
"overrideArtifactName":{"shape":"WrapperBoolean"},
"encryptionDisabled":{"shape":"WrapperBoolean"},
- "artifactIdentifier":{"shape":"String"},
- "bucketOwnerAccess":{"shape":"BucketOwnerAccess"}
+ "artifactIdentifier":{"shape":"String"}
}
},
"BuildArtifactsList":{
@@ -1730,8 +1721,7 @@
"packaging":{"shape":"ArtifactPackaging"},
"overrideArtifactName":{"shape":"WrapperBoolean"},
"encryptionDisabled":{"shape":"WrapperBoolean"},
- "artifactIdentifier":{"shape":"String"},
- "bucketOwnerAccess":{"shape":"BucketOwnerAccess"}
+ "artifactIdentifier":{"shape":"String"}
}
},
"ProjectArtifactsList":{
@@ -2124,8 +2114,7 @@
"members":{
"status":{"shape":"LogsConfigStatusType"},
"location":{"shape":"String"},
- "encryptionDisabled":{"shape":"WrapperBoolean"},
- "bucketOwnerAccess":{"shape":"BucketOwnerAccess"}
+ "encryptionDisabled":{"shape":"WrapperBoolean"}
}
},
"S3ReportExportConfig":{
diff --git a/models/apis/codebuild/2016-10-06/docs-2.json b/models/apis/codebuild/2016-10-06/docs-2.json
index 7d467d4dcec..ca98b58111f 100644
--- a/models/apis/codebuild/2016-10-06/docs-2.json
+++ b/models/apis/codebuild/2016-10-06/docs-2.json
@@ -1,6 +1,6 @@
{
"version": "2.0",
- "service": "AWS CodeBuild
AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.
",
+ "service": "
CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
",
"operations": {
"BatchDeleteBuilds": "
Deletes one or more builds.
",
"BatchGetBuildBatches": "
Retrieves information about one or more batch builds.
",
@@ -10,31 +10,31 @@
"BatchGetReports": "
Returns an array of reports.
",
"CreateProject": "
Creates a build project.
",
"CreateReportGroup": "
Creates a report group. A report group contains a collection of reports.
",
- "CreateWebhook": "
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
",
+ "CreateWebhook": "
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
",
"DeleteBuildBatch": "
Deletes a batch build.
",
"DeleteProject": "
Deletes a build project. When you delete a project, its builds are not deleted.
",
"DeleteReport": "
Deletes a report.
",
"DeleteReportGroup": "
Deletes a report group. Before you delete a report group, you must delete its reports.
",
"DeleteResourcePolicy": "
Deletes a resource policy that is identified by its resource ARN.
",
"DeleteSourceCredentials": "
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
",
- "DeleteWebhook": "
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
",
+ "DeleteWebhook": "
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
",
"DescribeCodeCoverages": "
Retrieves one or more code coverage reports.
",
"DescribeTestCases": "
Returns a list of details about test cases for a report.
",
"GetReportGroupTrend": "
Analyzes and accumulates test report values for the specified test reports.
",
"GetResourcePolicy": "
Gets a resource policy that is identified by its resource ARN.
",
- "ImportSourceCredentials": "
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
",
+ "ImportSourceCredentials": "
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
",
"InvalidateProjectCache": "
Resets the cache for a project.
",
"ListBuildBatches": "
Retrieves the identifiers of your build batches in the current region.
",
"ListBuildBatchesForProject": "
Retrieves the identifiers of the build batches for a specific project.
",
"ListBuilds": "
Gets a list of build IDs, with each build ID representing a single build.
",
"ListBuildsForProject": "
Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
",
- "ListCuratedEnvironmentImages": "
Gets information about Docker images that are managed by AWS CodeBuild.
",
+ "ListCuratedEnvironmentImages": "
Gets information about Docker images that are managed by CodeBuild.
",
"ListProjects": "
Gets a list of build project names, with each build project name representing a single build project.
",
- "ListReportGroups": "
Gets a list ARNs for the report groups in the current AWS account.
",
- "ListReports": "
Returns a list of ARNs for the reports in the current AWS account.
",
+ "ListReportGroups": "
Gets a list ARNs for the report groups in the current Amazon Web Services account.
",
+ "ListReports": "
Returns a list of ARNs for the reports in the current Amazon Web Services account.
",
"ListReportsForReportGroup": "
Returns a list of ARNs for the reports that belong to a ReportGroup.
",
- "ListSharedProjects": "
Gets a list of projects that are shared with other AWS accounts or users.
",
- "ListSharedReportGroups": "
Gets a list of report groups that are shared with other AWS accounts or users.
",
+ "ListSharedProjects": "
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
",
+ "ListSharedReportGroups": "
Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
",
"ListSourceCredentials": "
Returns a list of SourceCredentialsInfo objects.
",
"PutResourcePolicy": "
Stores a resource policy for the ARN of a Project or ReportGroup object.
",
"RetryBuild": "
Restarts a build.
",
@@ -45,37 +45,37 @@
"StopBuildBatch": "
Stops a running batch build.
",
"UpdateProject": "
Changes the settings of a build project.
",
"UpdateReportGroup": "
Updates a report group.
",
- "UpdateWebhook": "
Updates the webhook associated with an AWS CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
"
+ "UpdateWebhook": "
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
"
+ "ProjectArtifacts$namespaceType": "
Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
"
+ "ProjectArtifacts$packaging": "
The type of build output artifact to create:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.
",
+ "ImportSourceCredentialsInput$authType": "
The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.
",
"SourceCredentialsInfo$authType": "
The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.
"
}
},
- "BucketOwnerAccess": {
- "base": "
Specifies the access for objects that are uploaded to an Amazon S3 bucket that is owned by another account.
By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.
NONE
The bucket owner does not have access to the objects. This is the default.
READ_ONLY
The bucket owner has read only access to the objects. The uploading account retains ownership of the objects.
FULL
The bucket owner has full access to the objects. Object ownership is determined by the following criteria:
If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.
Otherwise, the uploading account retains ownership of the objects.
Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
",
+ "base": "
Contains information that defines how the CodeBuild build project reports the build status to the source provider.
",
"refs": {
"ProjectSource$buildStatusConfig": "
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
",
"StartBuildInput$buildStatusConfigOverride": "
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
"
+ "BatchRestrictions$computeTypesAllowed": "
An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
",
+ "ProjectEnvironment$type": "
The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
"
+ "EnvironmentVariable$type": "
The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.
Contains information about an exported environment variable.
Exported environment variables are used in conjunction with AWS CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the AWS CodePipeline User Guide.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
",
+ "base": "
Contains information about an exported environment variable.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with AWS CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the AWS CodePipeline User Guide.
"
+ "Build$exportedEnvironmentVariables": "
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values:
CODEBUILD
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
SERVICE_ROLE
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
SERVICE_ROLE
Specifies that AWS CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
CODEBUILD
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
SERVICE_ROLE
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
SERVICE_ROLE
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
An identifier for the version of this build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon S3, this does not apply.
",
- "Build$projectName": "
The name of the AWS CodeBuild project.
",
+ "Build$sourceVersion": "
Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
",
- "CreateProjectInput$encryptionKey": "
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
+ "CreateProjectInput$serviceRole": "
The ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
",
+ "CreateProjectInput$encryptionKey": "
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
"DebugSession$sessionTarget": "
Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
"ListSharedProjectsInput$nextToken": "
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
"NetworkInterface$subnetId": "
The ID of the subnet.
",
"NetworkInterface$networkInterfaceId": "
The ID of the network interface.
",
- "Project$serviceRole": "
The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
",
- "Project$encryptionKey": "
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
+ "Project$serviceRole": "
The ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
",
+ "Project$encryptionKey": "
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
Specifies the service role ARN for the batch build project.
",
- "ProjectEnvironment$image": "
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.
For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
",
+ "ProjectEnvironment$image": "
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.
For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
- "StartBuildInput$projectName": "
The name of the AWS CodeBuild build project to start running a build.
The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
+ "StartBuildInput$projectName": "
The name of the CodeBuild build project to start running a build.
",
"StartBuildInput$imageOverride": "
The name of an image for this build that overrides the one specified in the build project.
",
"StartBuildInput$serviceRoleOverride": "
The name of a service role for this build that overrides the one specified in the build project.
",
- "StartBuildInput$encryptionKeyOverride": "
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
+ "StartBuildInput$encryptionKeyOverride": "
The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
The ARN of the report to which the test case belongs.
",
"UpdateProjectInput$name": "
The name of the build project.
You cannot change a build project's name.
",
- "UpdateProjectInput$serviceRole": "
The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
",
- "UpdateProjectInput$encryptionKey": "
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
+ "UpdateProjectInput$serviceRole": "
The replacement ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
",
+ "UpdateProjectInput$encryptionKey": "
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
",
"UpdateReportGroupInput$arn": "
The ARN of the report group to update.
",
"VpcConfig$vpcId": "
The ID of the Amazon VPC.
",
"Webhook$url": "
The URL to the webhook.
",
- "Webhook$payloadUrl": "
The AWS CodeBuild endpoint where webhook events are sent.
",
+ "Webhook$payloadUrl": "
The CodeBuild endpoint where webhook events are sent.
The names or ARNs of the build projects. To get information about a project shared with your AWS account, its ARN must be specified. You cannot specify a shared project using its name.
",
+ "BatchGetProjectsInput$names": "
The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
",
"BatchGetProjectsOutput$projectsNotFound": "
The names of build projects for which information could not be found.
",
"ListProjectsOutput$projects": "
The list of build project names, with each build project name representing a single build project.
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
",
- "BuildBatch$secondarySourceVersions": "
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
",
+ "Build$secondarySourceVersions": "
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
",
+ "BuildBatch$secondarySourceVersions": "
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
",
"Project$secondarySourceVersions": "
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
",
+ "base": "
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
",
"refs": {
- "ProjectSource$auth": "
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
",
+ "ProjectSource$auth": "
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
",
"StartBuildBatchInput$sourceAuthOverride": "
A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.
",
"StartBuildInput$sourceAuthOverride": "
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
Bitbucket
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
GitHub/GitHub Enterprise Server
This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
",
"BuildStatusConfig$targetUrl": "
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
Bitbucket
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
GitHub/GitHub Enterprise Server
This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
",
"DeleteBuildBatchOutput$statusCode": "
The status code.
",
"DescribeCodeCoveragesInput$nextToken": "
The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
"EnvironmentImage$name": "
The name of the Docker image.
",
"EnvironmentImage$description": "
The description of the Docker image.
",
- "EnvironmentVariable$value": "
The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
",
+ "EnvironmentVariable$value": "
The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
",
"ExportedEnvironmentVariable$value": "
The value assigned to the exported environment variable.
The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
"ListSharedReportGroupsInput$nextToken": "
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
"ListSharedReportGroupsOutput$nextToken": "
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
",
- "LogsLocation$groupName": "
The name of the Amazon CloudWatch Logs group for the build logs.
",
- "LogsLocation$streamName": "
The name of the Amazon CloudWatch Logs stream for the build logs.
",
- "LogsLocation$deepLink": "
The URL to an individual build log in Amazon CloudWatch Logs.
",
+ "LogsLocation$groupName": "
The name of the CloudWatch Logs group for the build logs.
",
+ "LogsLocation$streamName": "
The name of the CloudWatch Logs stream for the build logs.
",
+ "LogsLocation$deepLink": "
The URL to an individual build log in CloudWatch Logs.
",
"LogsLocation$s3DeepLink": "
The URL to a build log in an S3 bucket.
",
- "LogsLocation$cloudWatchLogsArn": "
The ARN of Amazon CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For more information, see Resources Defined by Amazon CloudWatch Logs.
",
+ "LogsLocation$cloudWatchLogsArn": "
The ARN of CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For more information, see Resources Defined by CloudWatch Logs.
",
"LogsLocation$s3LogsArn": "
The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
",
"PhaseContext$statusCode": "
The status code for the context of the build phase.
",
"PhaseContext$message": "
An explanation of the build phase's context. This might include a command ID and an exit code.
",
"Project$arn": "
The Amazon Resource Name (ARN) of the build project.
",
- "Project$sourceVersion": "
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
Information about the build output artifact location:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output bucket.
",
- "ProjectArtifacts$path": "
Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
",
- "ProjectArtifacts$name": "
Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.
For example:
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/<build-ID>.
",
+ "Project$sourceVersion": "
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
Information about the build output artifact location:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output bucket.
",
+ "ProjectArtifacts$path": "
Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
",
+ "ProjectArtifacts$name": "
Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.
For example:
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/<build-ID>.
",
"ProjectArtifacts$artifactIdentifier": "
An identifier for this artifact definition.
",
"ProjectBadge$badgeRequestUrl": "
The publicly-accessible URL through which you can access the build badge for your project.
",
"ProjectCache$location": "
Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the S3 bucket name/prefix.
",
- "ProjectEnvironment$certificate": "
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide.
",
- "ProjectFileSystemLocation$location": "
A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
",
+ "ProjectEnvironment$certificate": "
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.
",
+ "ProjectFileSystemLocation$location": "
A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
",
"ProjectFileSystemLocation$mountPoint": "
The location in the container where you mount the file system.
",
"ProjectFileSystemLocation$identifier": "
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.
The identifier is used to mount your file system.
",
- "ProjectFileSystemLocation$mountOptions": "
The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
",
- "ProjectSource$location": "
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
",
- "ProjectSource$buildspec": "
The buildspec file declaration to use for the builds in this build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
+ "ProjectFileSystemLocation$mountOptions": "
The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
",
+ "ProjectSource$location": "
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.
If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.
",
+ "ProjectSource$buildspec": "
The buildspec file declaration to use for the builds in this build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
"ProjectSource$sourceIdentifier": "
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
",
"ProjectSourceVersion$sourceIdentifier": "
An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
",
- "ProjectSourceVersion$sourceVersion": "
The source version for the corresponding source identifier. If specified, must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
The source version for the corresponding source identifier. If specified, must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
The value of the requested data field from the report.
",
"ResolvedArtifact$location": "
The location of the artifact.
",
"ResolvedArtifact$identifier": "
The identifier of the artifact.
",
- "RetryBuildBatchInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
",
- "RetryBuildInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
",
+ "RetryBuildBatchInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
",
+ "RetryBuildInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
",
"S3LogsConfig$location": "
The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.
",
- "S3ReportExportConfig$bucketOwner": "
The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
",
+ "S3ReportExportConfig$bucketOwner": "
The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
",
"S3ReportExportConfig$path": "
The path to the exported report's raw data results.
",
"SourceAuth$resource": "
The resource value that applies to the specified authorization type.
",
- "StartBuildBatchInput$sourceVersion": "
The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
AWS CodeCommit
The commit ID, branch, or Git tag to use.
GitHub
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Bitbucket
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Amazon S3
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
CodeCommit
The commit ID, branch, or Git tag to use.
GitHub
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Bitbucket
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Amazon S3
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
A location that overrides, for this batch build, the source location defined in the batch build project.
",
- "StartBuildBatchInput$buildspecOverride": "
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
+ "StartBuildBatchInput$buildspecOverride": "
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
"StartBuildBatchInput$certificateOverride": "
The name of a certificate for this batch build that overrides the one specified in the batch build project.
",
- "StartBuildBatchInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
",
- "StartBuildInput$sourceVersion": "
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
AWS CodeCommit
The commit ID, branch, or Git tag to use.
GitHub
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Bitbucket
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Amazon S3
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
",
+ "StartBuildInput$sourceVersion": "
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
CodeCommit
The commit ID, branch, or Git tag to use.
GitHub
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Bitbucket
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
Amazon S3
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
A location that overrides, for this build, the source location for the one defined in the build project.
",
- "StartBuildInput$buildspecOverride": "
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
+ "StartBuildInput$buildspecOverride": "
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
",
"StartBuildInput$certificateOverride": "
The name of a certificate for this build that overrides the one specified in the build project.
",
- "StartBuildInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
",
+ "StartBuildInput$idempotencyToken": "
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
",
"TestCase$testRawDataPath": "
The path to the raw data file that contains the test result.
",
"TestCase$prefix": "
A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.
",
"TestCase$name": "
The name of the test case.
",
@@ -1636,7 +1628,7 @@
"TestCase$message": "
A message associated with a test case. For example, an error message or stack trace.
",
"TestCaseFilter$status": "
The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
",
"TestCaseFilter$keyword": "
A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned.
",
- "UpdateProjectInput$sourceVersion": "
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For AWS CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
",
"Webhook$branchFilter": "
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
",
"WebhookFilter$pattern": "
For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.
For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.
"
@@ -1649,7 +1641,7 @@
}
},
"Tag": {
- "base": "
A tag, consisting of a key and a value.
This tag is available for use by AWS services that support tags in AWS CodeBuild.
",
+ "base": "
A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
",
+ "CreateProjectInput$timeoutInMinutes": "
How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
",
"CreateProjectInput$queuedTimeoutInMinutes": "
The number of minutes a build is allowed to be queued before it times out.
",
- "Project$timeoutInMinutes": "
How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
",
+ "Project$timeoutInMinutes": "
How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
",
"Project$queuedTimeoutInMinutes": "
The number of minutes a build is allowed to be queued before it times out.
The number of minutes a batch build is allowed to be queued before it times out.
",
"StartBuildInput$timeoutInMinutesOverride": "
The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
The number of minutes a build is allowed to be queued before it times out.
",
- "UpdateProjectInput$timeoutInMinutes": "
The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
",
+ "UpdateProjectInput$timeoutInMinutes": "
The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
",
"UpdateProjectInput$queuedTimeoutInMinutes": "
The number of minutes a build is allowed to be queued before it times out.
Information about the VPC configuration that AWS CodeBuild accesses.
",
+ "base": "
Information about the VPC configuration that CodeBuild accesses.
",
"refs": {
- "Build$vpcConfig": "
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
",
+ "Build$vpcConfig": "
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
",
"CreateProjectInput$badgeEnabled": "
Set this to true to generate a publicly accessible URL for your project's build badge.
",
"DebugSession$sessionEnabled": "
Specifies if session debugging is enabled for this build.
",
- "GitSubmodulesConfig$fetchSubmodules": "
Set to true to fetch Git submodules for your AWS CodeBuild build project.
",
+ "GitSubmodulesConfig$fetchSubmodules": "
Set to true to fetch Git submodules for your CodeBuild build project.
Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
",
"ProjectArtifacts$overrideArtifactName": "
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
",
"ProjectArtifacts$encryptionDisabled": "
Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.
",
"ProjectBuildBatchConfig$combineArtifacts": "
Specifies if the build artifacts for the batch build should be combined into a single artifact location.
",
"ProjectEnvironment$privilegedMode": "
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"
",
- "ProjectSource$reportBuildStatus": "
Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
",
+ "ProjectSource$reportBuildStatus": "
Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
",
"ProjectSource$insecureSsl": "
Enable this flag to ignore SSL warnings while connecting to the project source code.
",
"Report$truncated": "
A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
",
"S3LogsConfig$encryptionDisabled": "
Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
Enable this flag to override privileged mode in the batch build project.
",
"StartBuildBatchInput$debugSessionEnabled": "
Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
",
"StartBuildInput$insecureSslOverride": "
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
",
"StartBuildInput$privilegedModeOverride": "
Enable this flag to override privileged mode in the build project.
This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
",
"CreateIntegrationAssociation": "
Create an AppIntegration association with an Amazon Connect instance.
",
"CreateQueue": "
This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
",
- "CreateQuickConnect": "
This API is in preview release for Amazon Connect and is subject to change.
Creates a quick connect for the specified Amazon Connect instance.
",
+ "CreateQuickConnect": "
Creates a quick connect for the specified Amazon Connect instance.
",
"CreateRoutingProfile": "
Creates a new routing profile.
",
"CreateUseCase": "
Creates a use case for an AppIntegration association.
",
"CreateUser": "
Creates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
",
"CreateUserHierarchyGroup": "
Creates a new user hierarchy group.
",
"DeleteInstance": "
This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
",
"DeleteIntegrationAssociation": "
Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
",
- "DeleteQuickConnect": "
This API is in preview release for Amazon Connect and is subject to change.
Deletes a quick connect.
",
+ "DeleteQuickConnect": "
Deletes a quick connect.
",
"DeleteUseCase": "
Deletes a use case from an AppIntegration association.
",
"DeleteUser": "
Deletes a user account from the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
",
"DescribeInstanceStorageConfig": "
This API is in preview release for Amazon Connect and is subject to change.
Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
",
"DescribeQueue": "
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
",
- "DescribeQuickConnect": "
This API is in preview release for Amazon Connect and is subject to change.
Describes the quick connect.
",
+ "DescribeQuickConnect": "
Describes the quick connect.
",
"DescribeRoutingProfile": "
Describes the specified routing profile.
",
"DescribeUser": "
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
",
"DescribeUserHierarchyGroup": "
Describes the specified hierarchy group.
",
@@ -62,7 +62,7 @@
"ListPrompts": "
Provides information about the prompts for the specified Amazon Connect instance.
",
"ListQueueQuickConnects": "
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
",
"ListQueues": "
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
",
- "ListQuickConnects": "
This API is in preview release for Amazon Connect and is subject to change.
Provides information about the quick connects for the specified Amazon Connect instance.
",
+ "ListQuickConnects": "
Provides information about the quick connects for the specified Amazon Connect instance.
",
"ListRoutingProfileQueues": "
Lists the queues associated with a routing profile.
",
"ListRoutingProfiles": "
Provides summary information about the routing profiles for the specified Amazon Connect instance.
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
",
@@ -91,8 +91,8 @@
"UpdateQueueName": "
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a queue. At least Name or Description must be provided.
",
"UpdateQueueOutboundCallerConfig": "
This API is in preview release for Amazon Connect and is subject to change.
Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.
",
"UpdateQueueStatus": "
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
",
- "UpdateQuickConnectConfig": "
This API is in preview release for Amazon Connect and is subject to change.
Updates the configuration settings for the specified quick connect.
",
- "UpdateQuickConnectName": "
This API is in preview release for Amazon Connect and is subject to change.
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.
",
+ "UpdateQuickConnectConfig": "
Updates the configuration settings for the specified quick connect.
",
+ "UpdateQuickConnectName": "
Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.
",
"UpdateRoutingProfileConcurrency": "
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
",
"UpdateRoutingProfileDefaultOutboundQueue": "
Updates the default outbound queue of a routing profile.
",
"UpdateRoutingProfileName": "
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.
",
+ "base": "
Represents the information required for client programs to connect to the endpoint for a DAX cluster.
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
",
+ "Cluster$ClusterDiscoveryEndpoint": "
The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.
",
"Node$Endpoint": "
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
",
"DescribeSubnetGroupsResponse$NextToken": "
Provides an identifier to allow retrieval of paginated results.
",
"Endpoint$Address": "
The DNS hostname of the endpoint.
",
+ "Endpoint$URL": "
The URL that applications should use to connect to the endpoint. The default ports are 8111 for the \"dax\" protocol and 9111 for the \"daxs\" protocol.
",
"Event$SourceName": "
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
The Amazon Resource Name (ARN) that identifies the topic.
",
- "NotificationConfiguration$TopicStatus": "
The current state of the topic.
",
+ "NotificationConfiguration$TopicStatus": "
The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
",
"UpdateClusterRequest$NotificationTopicArn": "
The Amazon Resource Name (ARN) that identifies the topic.
The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.
The S3 path where your block list text file sits in S3.
If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.
If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
",
"SalesforceConfiguration$SecretArn": "
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
",
"ServiceNowConfiguration$SecretArn": "
The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
",
- "SharePointConfiguration$SecretArn": "
The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
"
+ "SharePointConfiguration$SecretArn": "
The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Sever, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.
The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only AWS service principals and authorized users within the S3 bucket owner's account.
Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to true, the delete marker is expired. If set to false, the policy takes no action.
If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays or ExpirationDate.
The key-value pair that exists if the Amazon ES domain uses VPC endpoints.
",
"AwsLambdaFunctionEnvironment$Variables": "
Environment variable key-value pairs.
",
"AwsSecurityFinding$ProductFields": "
A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.
Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.
The number of days after the previous rotation to rotate the secret.
",
"AwsSecurityFinding$Confidence": "
A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
",
"AwsSecurityFinding$Criticality": "
The level of importance assigned to the resources associated with the finding.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
The type of credentials AWS CodeBuild uses to pull images in your build.
Valid values:
CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal.
SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
",
"AwsCodeBuildProjectEnvironment$Type": "
The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The service that created the credentials to access a private Docker registry.
The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
",
"AwsCodeBuildProjectSource$Type": "
The type of repository that contains the source code to be built. Valid values are:
BITBUCKET - The source code is in a Bitbucket repository.
CODECOMMIT - The source code is in an AWS CodeCommit repository.
CODEPIPELINE - The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
GITHUB - The source code is in a GitHub repository.
GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository.
NO_SOURCE - The project does not have input source code.
S3 - The source code is in an S3 input bucket.
",
"AwsCodeBuildProjectSource$Location": "
Information about the location of the source code to be built.
Valid values include:
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
For source code in an S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).
The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another VPC.
",
"AwsEc2SecurityGroupUserIdGroupPair$VpcId": "
The ID of the VPC for the referenced security group, if applicable.
The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
",
"AwsEc2VpcDetails$DhcpOptionsId": "
The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.
The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops.
The epoch time when the deployment window closes for required updates. After this time, Amazon Elasticsearch Service schedules the software upgrade automatically.
The name of the feature associated with the IAM)role.
",
"AwsRdsDbInstanceAssociatedRole$Status": "
Describes the state of the association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - The IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.
PENDING - The IAM role ARN is being associated with the DB instance.
INVALID - The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.
The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
A list of links for the container in the form container_name:alias. Allows containers to communicate with each other without the need for port mappings.
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
AWS Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
",
+ "service": "
Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no infrastructure to buy and set up.
",
"operations": {
- "CreateAccess": "
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using AWS Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
",
- "CreateServer": "
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
",
- "CreateUser": "
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
",
+ "CreateAccess": "
Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
",
+ "CreateServer": "
Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
",
+ "CreateUser": "
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Amazon Web Services Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
",
"DeleteAccess": "
Allows you to delete the access specified in the ServerID and ExternalID parameters.
",
"DeleteServer": "
Deletes the file transfer protocol-enabled server that you specify.
No response returns from this operation.
",
"DeleteSshPublicKey": "
Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
",
@@ -16,7 +16,7 @@
"ImportSshPublicKey": "
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
",
"ListAccesses": "
Lists the details for all the accesses you have on your server.
",
"ListSecurityPolicies": "
Lists the security policies that are attached to your file transfer protocol-enabled servers.
",
- "ListServers": "
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
",
+ "ListServers": "
Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.
",
"ListTagsForResource": "
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
",
"ListUsers": "
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
",
"StartServer": "
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
Specifies the unique Amazon Resource Name (ARN) of the server.
",
"DescribedUser$Arn": "
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
",
- "ListTagsForResourceRequest$Arn": "
Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.
",
+ "ListTagsForResourceRequest$Arn": "
Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.
",
"ListTagsForResourceResponse$Arn": "
The ARN you specified to list the tags of.
",
"ListedServer$Arn": "
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
",
"ListedUser$Arn": "
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
",
- "TagResourceRequest$Arn": "
An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.
",
- "UntagResourceRequest$Arn": "
The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.
"
+ "TagResourceRequest$Arn": "
An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.
",
+ "UntagResourceRequest$Arn": "
The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
",
- "DescribedServer$Certificate": "
Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
",
- "UpdateServerRequest$Certificate": "
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
"
+ "CreateServerRequest$Certificate": "
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web Services Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web Services Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
",
+ "DescribedServer$Certificate": "
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
",
+ "UpdateServerRequest$Certificate": "
The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
",
+ "base": "
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
",
- "DescribedServer$EndpointDetails": "
Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
",
- "UpdateServerRequest$EndpointDetails": "
The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.
"
+ "DescribedServer$EndpointDetails": "
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
",
+ "UpdateServerRequest$EndpointDetails": "
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
",
+ "CreateServerRequest$EndpointType": "
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
",
"DescribedServer$EndpointType": "
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"ListedServer$EndpointType": "
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
- "UpdateServerRequest$EndpointType": "
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
"
+ "UpdateServerRequest$EndpointType": "
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "CreateAccessResponse$ExternalId": "
The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family.
",
- "DeleteAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "DescribeAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "DescribedAccess$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "ListedAccess$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "UpdateAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
- "UpdateAccessResponse$ExternalId": "
The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer Family.
"
+ "CreateAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "CreateAccessResponse$ExternalId": "
The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family.
",
+ "DeleteAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "DescribeAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "DescribedAccess$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "ListedAccess$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "UpdateAccessRequest$ExternalId": "
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
In that command, replace YourGroupName with the name of your Active Directory group.
The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
",
+ "UpdateAccessResponse$ExternalId": "
The external ID of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer Family.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your directory. If using the AWS CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you can use the following.
The end of the key name must end in a / for it to be considered a folder.
",
- "CreateUserRequest$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
- "DescribedAccess$HomeDirectoryMappings": "
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.
In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
",
- "DescribedUser$HomeDirectoryMappings": "
Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your directory. If using the AWS CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you can use the following.
The end of the key name must end in a / for it to be considered a folder.
",
- "UpdateUserRequest$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your directory. If using the AWS CLI, use the s3api or efsapi call instead of s3efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
+ "CreateUserRequest$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
+ "DescribedAccess$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
",
+ "DescribedUser$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
+ "UpdateUserRequest$HomeDirectoryMappings": "
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
In most cases, you can use this value instead of the scope-down policy to lock down your user to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f my-new-server-key.
If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f my-new-server-key.
If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. For AWS_DIRECTORY_SERVICE or SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on the server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. The server can have only one method of authentication.
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the AWS Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
- "DescribedServer$IdentityProviderType": "
Specifies the mode of authentication method enabled for this service. A value of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
- "ListedServer$IdentityProviderType": "
Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), Active Directory groups, user name and password combinations, or your own custom authentication method.
"
+ "CreateServerRequest$IdentityProviderType": "
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
+ "DescribedServer$IdentityProviderType": "
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
+ "ListedServer$IdentityProviderType": "
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 or Amazon EFS events to be logged in Amazon CloudWatch, turning logging on or off.
"
+ "UpdateServerRequest$LoggingRole": "
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. For example:
aws transfer update-server --protocol-details PassiveIp=0.0.0.0
Replace 0.0.0.0 in the example above with the actual IP address you want to use.
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope-down policies.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
",
- "CreateUserRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. EFS does not use scope down policy.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
",
+ "CreateAccessRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope-down policies.
For scope-down policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
",
+ "CreateUserRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. EFS does not use scope down policy.
For scope-down policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
",
"DescribedAccess$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
",
"DescribedUser$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
",
- "UpdateAccessRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
",
- "UpdateUserRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope-down policies.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
"
+ "UpdateAccessRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, Amazon Web ServicesTransfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
",
+ "UpdateUserRequest$Policy": "
A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
This only applies when domain of ServerId is S3. Amazon EFS does not use scope-down policies.
For scope-down policies, Amazon Web ServicesTransfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
",
+ "UpdateServerRequest$ProtocolDetails": "
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
",
+ "CreateServerRequest$Protocols": "
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
",
"DescribedServer$Protocols": "
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer
",
- "UpdateServerRequest$Protocols": "
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
"
+ "UpdateServerRequest$Protocols": "
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
- "CreateServerRequest$LoggingRole": "
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
+ "CreateServerRequest$LoggingRole": "
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
",
"CreateUserRequest$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
"DescribedAccess$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
- "DescribedServer$LoggingRole": "
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
",
+ "DescribedServer$LoggingRole": "
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
",
"DescribedUser$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
"IdentityProviderDetails$InvocationRole": "
Provides the type of InvocationRole used to authenticate the user account.
",
"ListedAccess$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
- "ListedServer$LoggingRole": "
Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
",
+ "ListedServer$LoggingRole": "
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
",
"ListedUser$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
",
"UpdateAccessRequest$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
",
"UpdateUserRequest$Role": "
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
A unique string that identifies a user account associated with a server.
",
"DeleteSshPublicKeyRequest$UserName": "
A unique string that identifies a user whose public key is being deleted.
",
"DeleteUserRequest$UserName": "
A unique string that identifies a user that is being deleted from a server.
",
- "DescribeUserRequest$UserName": "
The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.
",
+ "DescribeUserRequest$UserName": "
The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.
",
"DescribedUser$UserName": "
Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.
",
"ImportSshPublicKeyRequest$UserName": "
The name of the user account that is assigned to one or more servers.
",
"ImportSshPublicKeyResponse$UserName": "
A user name assigned to the ServerID value that you specified.
This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide.
AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AWS AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a Web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL calls.
The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
",
+ "service": "WAF
This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces.
For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide.
WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.
This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and an overview of how to use WAF, see the WAF Developer Guide.
For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
",
"operations": {
- "AssociateWebACL": "
Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.
",
- "CheckCapacity": "
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
",
- "CreateIPSet": "
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.
Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.
",
+ "CheckCapacity": "
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
",
+ "CreateIPSet": "
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.
",
- "DeleteFirewallManagerRuleGroups": "
Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
",
+ "DeleteFirewallManagerRuleGroups": "
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
You can only use this if ManagedByFirewallManager is false in the specified WebACL.
",
"DescribeManagedRuleGroup": "
Provides high-level information for a managed rule group, including descriptions of the rules.
",
- "DisassociateWebACL": "
Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
",
+ "DisassociateWebACL": "
Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.
Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
",
"GetRateBasedStatementManagedKeys": "
Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.
",
+ "GetSampledRequests": "
Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.
Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.
",
+ "ListAvailableManagedRuleGroups": "
Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and the Marketplace managed rule groups that you're subscribed to.
",
"ListIPSets": "
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
",
- "ListResourcesForWebACL": "
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.
",
+ "ListResourcesForWebACL": "
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.
",
"ListRuleGroups": "
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
",
- "ListTagsForResource": "
Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
",
+ "ListTagsForResource": "
Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
",
"ListWebACLs": "
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
",
- "PutLoggingConfiguration": "
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.
Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
",
- "PutPermissionPolicy": "
Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same region.
The user making the request must be the owner of the rule group.
",
- "TagResource": "
Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
",
- "UntagResource": "
Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.
This operation completely replaces any IP address specifications that you already have in the IP set with the ones that you provide to this call. If you want to add to or modify the addresses that are already in the IP set, retrieve those by calling GetIPSet, update them, and provide the complete updated array of IP addresses to this call.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.
"
+ "PutLoggingConfiguration": "
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose.
Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).
Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.
Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the WAF Developer Guide.
This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
",
+ "PutPermissionPolicy": "
Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.
You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
You can attach only one policy with each PutPermissionPolicy request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
The user making the request must be the owner of the rule group.
",
+ "TagResource": "
Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
",
+ "UntagResource": "
Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
Inspect all of the elements that AWS WAF has parsed and extracted from the web request JSON body that are within the JsonBodyMatchScope. This is used with the FieldToMatch option JsonBody.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
",
+ "base": "
Inspect all of the elements that WAF has parsed and extracted from the web request JSON body that are within the JsonBodyMatchScope. This is used with the FieldToMatch option JsonBody.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
",
"refs": {
"JsonMatchPattern$All": "
Match all of the elements. See also MatchScope in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not both.
"
}
},
"AllQueryArguments": {
- "base": "
All query arguments of a web request.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
",
+ "base": "
All query arguments of a web request.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
",
"refs": {
"FieldToMatch$AllQueryArguments": "
Inspect all query arguments.
"
}
},
"AllowAction": {
- "base": "
Specifies that AWS WAF should allow the request and optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
+ "base": "
Specifies that WAF should allow the request and optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
"refs": {
- "DefaultAction$Allow": "
Specifies that AWS WAF should allow requests by default.
",
- "RuleAction$Allow": "
Instructs AWS WAF to allow the web request.
"
+ "DefaultAction$Allow": "
Specifies that WAF should allow requests by default.
Specifies that AWS WAF should block the request and optionally defines additional custom handling for the response to the web request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
+ "base": "
Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
"refs": {
- "DefaultAction$Block": "
Specifies that AWS WAF should block requests by default.
",
- "RuleAction$Block": "
Instructs AWS WAF to block the web request.
"
+ "DefaultAction$Block": "
Specifies that WAF should block requests by default.
",
+ "RuleAction$Block": "
Instructs WAF to block the web request.
"
}
},
"Body": {
- "base": "
The body of a web request. This immediately follows the request headers.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
",
+ "base": "
The body of a web request. This immediately follows the request headers.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
",
"refs": {
- "FieldToMatch$Body": "
Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
"
+ "FieldToMatch$Body": "
Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.
AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
AWS WAF parses the JSON in the following examples as two valid key, value pairs:
Extra colons: {\"key1\"::\"value1\",\"key2\"\"value2\"}
"
+ "JsonBody$InvalidFallbackBehavior": "
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as characters that aren't valid, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
",
- "VisibilityConfig$SampledRequestsEnabled": "
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
",
- "WebACL$ManagedByFirewallManager": "
Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
",
+ "VisibilityConfig$SampledRequestsEnabled": "
A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.
",
+ "WebACL$ManagedByFirewallManager": "
Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
"
}
},
"ByteMatchStatement": {
- "base": "
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
",
+ "base": "
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement.
",
"refs": {
- "Statement$ByteMatchStatement": "
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
"
+ "Statement$ByteMatchStatement": "
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement.
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
",
- "RuleGroup$Capacity": "
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
"
+ "CreateRuleGroupRequest$Capacity": "
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
",
+ "RuleGroup$Capacity": "
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
"
+ "WebACL$Capacity": "
The web ACL capacity units (WCUs) currently being used by this web ACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
"
}
},
"CountAction": {
- "base": "
Specifies that AWS WAF should count the request. Optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
+ "base": "
Specifies that WAF should count the request. Optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
"refs": {
"OverrideAction$Count": "
Override the rule action setting to count.
",
- "RuleAction$Count": "
Instructs AWS WAF to count the web request and allow it.
"
+ "RuleAction$Count": "
Instructs WAF to count the web request and allow it.
For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, AWS WAF inserts the header x-amzn-waf-sample.
"
+ "CustomHTTPHeader$Name": "
The name of the custom header.
For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.
The HTTP headers to insert into the request. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
",
+ "CustomResponse$ResponseHeaders": "
The HTTP headers to use in the response. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
"
}
},
"CustomRequestHandling": {
- "base": "
Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count.
Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
",
+ "RuleGroup$CustomResponseBodies": "
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
",
+ "WebACL$CustomResponseBodies": "
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.
",
+ "base": "
In a WebACL, this is the action that you want WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"DeleteRegexPatternSetRequest$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"DeleteRuleGroupRequest$Id": "
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
- "DeleteWebACLRequest$Id": "
The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
+ "DeleteWebACLRequest$Id": "
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"GetIPSetRequest$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"GetRegexPatternSetRequest$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"GetRuleGroupRequest$Id": "
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
- "GetWebACLRequest$Id": "
The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
+ "GetWebACLRequest$Id": "
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"IPSet$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"IPSetSummary$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"RegexPatternSet$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
@@ -435,9 +435,9 @@
"UpdateIPSetRequest$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"UpdateRegexPatternSetRequest$Id": "
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"UpdateRuleGroupRequest$Id": "
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
- "UpdateWebACLRequest$Id": "
The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
+ "UpdateWebACLRequest$Id": "
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
",
"WebACL$Id": "
A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.
",
- "WebACLSummary$Id": "
The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
"
+ "WebACLSummary$Id": "
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
The name of the IP set. You cannot change the name of an IPSet after you create it.
",
"CreateRegexPatternSetRequest$Name": "
The name of the set. You cannot change the name after you create the set.
",
"CreateRuleGroupRequest$Name": "
The name of the rule group. You cannot change the name of a rule group after you create it.
",
- "CreateWebACLRequest$Name": "
The name of the Web ACL. You cannot change the name of a Web ACL after you create it.
",
- "CustomResponse$CustomResponseBodyKey": "
References the response body that you want AWS WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.
",
+ "CreateWebACLRequest$Name": "
The name of the web ACL. You cannot change the name of a web ACL after you create it.
",
+ "CustomResponse$CustomResponseBodyKey": "
References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
",
- "IPSetForwardedIPConfig$FallbackBehavior": "
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
"
+ "ForwardedIPConfig$FallbackBehavior": "
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
",
+ "IPSetForwardedIPConfig$FallbackBehavior": "
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
"
}
},
"FieldToMatch": {
- "base": "
The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.
",
+ "base": "
The part of a web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.
The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
"
}
},
"FirewallManagerStatement": {
- "base": "
The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
",
+ "base": "
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
"
}
},
"ForwardedIPConfig": {
- "base": "
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
AWS WAF only evaluates the first IP address found in the specified HTTP header.
",
+ "base": "
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
",
- "RateBasedStatement$ForwardedIPConfig": "
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
This is required if AggregateKeyType is set to FORWARDED_IP.
"
+ "GeoMatchStatement$ForwardedIPConfig": "
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
",
+ "RateBasedStatement$ForwardedIPConfig": "
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This is required if AggregateKeyType is set to FORWARDED_IP.
The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
The options for this setting are the following:
FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
LAST - Inspect the last IP address in the list of IP addresses in the header.
ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.
"
+ "IPSetForwardedIPConfig$Position": "
The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.
The options for this setting are the following:
FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
LAST - Inspect the last IP address in the list of IP addresses in the header.
ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Examples:
To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
",
+ "base": "
Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
"
}
},
"IPSetReferenceStatement": {
- "base": "
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
",
+ "base": "
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
"
+ "Statement$IPSetReferenceStatement": "
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.
",
+ "base": "
The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
",
"refs": {
- "FieldToMatch$JsonBody": "
Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
"
+ "FieldToMatch$JsonBody": "
Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
"
}
},
"JsonMatchPattern": {
- "base": "
The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
",
+ "base": "
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
",
"refs": {
- "JsonBody$MatchPattern": "
The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
"
+ "JsonBody$MatchPattern": "
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
The string to match against. The setting you provide for this depends on the match statement's Scope settings:
If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.
"
+ "LabelMatchStatement$Key": "
The string to match against. The setting you provide for this depends on the match statement's Scope setting:
If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
",
+ "base": "
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
",
"refs": {
- "Statement$LabelMatchStatement": "
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
"
+ "Statement$LabelMatchStatement": "
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
",
"Label$Name": "
The label string.
",
"LabelNameCondition$LabelName": "
The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
",
"LabelSummary$Name": "
An individual label specification.
",
- "RuleGroup$LabelNamespace": "
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group name>:
When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
",
- "WebACL$LabelNamespace": "
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
"
+ "RuleGroup$LabelNamespace": "
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
",
+ "WebACL$LabelNamespace": "
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
",
- "RuleGroup$AvailableLabels": "
The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.
",
+ "RuleGroup$AvailableLabels": "
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.
",
"RuleGroup$ConsumedLabels": "
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
Separate each component of the label with a colon.
Each namespace or name can have up to 128 characters.
You can specify up to 5 namespaces in a label.
Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
",
- "SampledHTTPRequest$Labels": "
Labels applied to the web request by matching rules. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
"
+ "Rule$RuleLabels": "
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
Separate each component of the label with a colon.
Each namespace or name can have up to 128 characters.
You can specify up to 5 namespaces in a label.
Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.
For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
",
+ "SampledHTTPRequest$Labels": "
Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
"
+ "GetSampledRequestsRequest$MaxItems": "
The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "DeleteIPSetRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "DeleteRegexPatternSetRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "DeleteRuleGroupRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "DeleteWebACLRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "GetIPSetResponse$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "GetRegexPatternSetResponse$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "GetRuleGroupResponse$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "GetWebACLResponse$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "IPSetSummary$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "RegexPatternSetSummary$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "RuleGroupSummary$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "UpdateIPSetRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "UpdateIPSetResponse$NextLockToken": "
A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
- "UpdateRegexPatternSetRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
- "UpdateRuleGroupRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "UpdateRuleGroupResponse$NextLockToken": "
A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
- "UpdateWebACLRequest$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
- "UpdateWebACLResponse$NextLockToken": "
A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
- "WebACLSummary$LockToken": "
A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "DeleteIPSetRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "DeleteRegexPatternSetRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "DeleteRuleGroupRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "DeleteWebACLRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "GetIPSetResponse$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "GetRegexPatternSetResponse$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "GetRuleGroupResponse$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "GetWebACLResponse$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "IPSetSummary$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "RegexPatternSetSummary$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "RuleGroupSummary$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "UpdateIPSetRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "UpdateIPSetResponse$NextLockToken": "
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
+ "UpdateRegexPatternSetRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
+ "UpdateRuleGroupRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "UpdateRuleGroupResponse$NextLockToken": "
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
+ "UpdateWebACLRequest$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
",
+ "UpdateWebACLResponse$NextLockToken": "
A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.
",
+ "WebACLSummary$LockToken": "
A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
",
+ "base": "
Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
",
+ "base": "
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
",
+ "Statement$ManagedRuleGroupStatement": "
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace.
",
+ "base": "
High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Marketplace managed rule groups, which you can subscribe to through Marketplace.
The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
",
- "VisibilityConfig$MetricName": "
A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\"
"
+ "VisibilityConfig$MetricName": "
A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example \"All\" and \"Default_Action.\"
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListIPSetsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListIPSetsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListRegexPatternSetsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListRegexPatternSetsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListRuleGroupsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListRuleGroupsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListTagsForResourceRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListTagsForResourceResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListWebACLsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
- "ListWebACLsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListIPSetsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListIPSetsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListRegexPatternSetsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListRegexPatternSetsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListRuleGroupsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListRuleGroupsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListTagsForResourceRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListTagsForResourceResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListWebACLsRequest$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
",
+ "ListWebACLsResponse$NextMarker": "
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
"
}
},
"NoneAction": {
- "base": "
Specifies that AWS WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the OverrideAction on the Rule.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
",
+ "base": "
Specifies that WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the OverrideAction on the Rule.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
If the rule statement references a rule group, use this override action setting and not the action setting.
If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
If the rule statement references a rule group, use this override action setting and not the action setting.
If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
",
"Rule$OverrideAction": "
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.
Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.
In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
If the rule statement references a rule group, use this override action setting and not the action setting.
If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListIPSetsRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListLoggingConfigurationsRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListRegexPatternSetsRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListRuleGroupsRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListTagsForResourceRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
- "ListWebACLsRequest$Limit": "
The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListIPSetsRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListLoggingConfigurationsRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListRegexPatternSetsRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListRuleGroupsRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListTagsForResourceRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
",
+ "ListWebACLsRequest$Limit": "
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
The IAM policy that is attached to the specified rule group.
",
- "PutPermissionPolicyRequest$Policy": "
The policy to attach to the specified rule group.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. WAF rejects any extra actions or wildcard actions in the policy.
The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.
The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range.
The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot.
SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString.
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
"
+ "ByteMatchStatement$PositionalConstraint": "
The area within the portion of a web request that you want WAF to search for SearchString. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot.
SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString.
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
The query string of a web request. This is the part of a URL that appears after a ? character, if any.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
",
+ "base": "
The query string of a web request. This is the part of a URL that appears after a ? character, if any.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
",
"refs": {
"FieldToMatch$QueryString": "
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
"
}
},
"RateBasedStatement": {
- "base": "
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
An IP match statement with an IP set that specified the address 192.0.2.44.
A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
",
+ "base": "
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
An IP match statement with an IP set that specified the address 192.0.2.44.
A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
",
"refs": {
- "Statement$RateBasedStatement": "
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
An IP match statement with an IP set that specified the address 192.0.2.44.
A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
"
+ "Statement$RateBasedStatement": "
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
An IP match statement with an IP set that specified the address 192.0.2.44.
A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
AWS WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.
",
+ "base": "
Contains one or more regular expressions.
WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
",
+ "base": "
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
+ "base": "
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
",
+ "base": "
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
",
"refs": {
- "Rule$Action": "
The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
If the rule statement references a rule group, use the override action setting and not this action setting.
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
If the rule statement references a rule group, use the override action setting and not this action setting.
",
+ "RuleSummary$Action": "
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
",
"Statement$RuleGroupReferenceStatement": "
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
If you define more than one rule group in the first or last Firewall Manager rule groups, AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
",
- "Rule$Priority": "
If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
"
+ "FirewallManagerRuleGroup$Priority": "
If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
",
+ "Rule$Priority": "
If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
An array of Rule that you're configuring to use in a rule group or web ACL.
",
- "CreateRuleGroupRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
- "CreateWebACLRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
- "RuleGroup$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
- "UpdateRuleGroupRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
- "UpdateWebACLRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
",
- "WebACL$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
"
+ "CreateRuleGroupRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
",
+ "CreateWebACLRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
",
+ "RuleGroup$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
",
+ "UpdateRuleGroupRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
",
+ "UpdateWebACLRequest$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
",
+ "WebACL$Rules": "
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "CreateIPSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "CreateRegexPatternSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "CreateRuleGroupRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "CreateWebACLRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "DeleteIPSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "DeleteRegexPatternSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "DeleteRuleGroupRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "DeleteWebACLRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "DescribeManagedRuleGroupRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "GetIPSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "GetRegexPatternSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "GetRuleGroupRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "GetSampledRequestsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "GetWebACLRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "ListIPSetsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "ListLoggingConfigurationsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "ListRegexPatternSetsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "ListRuleGroupsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "ListWebACLsRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "UpdateIPSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "UpdateRegexPatternSetRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "UpdateRuleGroupRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
- "UpdateWebACLRequest$Scope": "
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
"
+ "CheckCapacityRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "CreateIPSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "CreateRegexPatternSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "CreateRuleGroupRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "CreateWebACLRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "DeleteIPSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "DeleteRegexPatternSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "DeleteRuleGroupRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "DeleteWebACLRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "DescribeManagedRuleGroupRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "GetIPSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "GetRegexPatternSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "GetRuleGroupRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "GetSampledRequestsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "GetWebACLRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "ListIPSetsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "ListLoggingConfigurationsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "ListRegexPatternSetsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "ListRuleGroupsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "ListWebACLsRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "UpdateIPSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "UpdateRegexPatternSetRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "UpdateRuleGroupRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
",
+ "UpdateWebACLRequest$Scope": "
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation specified in the request.
UriPath: The value that you want AWS WAF to search for in the URI path, for example, /images/daily-ad.jpg.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
"
+ "ByteMatchStatement$SearchString": "
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.
UriPath: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
"
}
},
"SingleHeader": {
- "base": "
One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
",
+ "base": "
One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
",
"refs": {
"FieldToMatch$SingleHeader": "
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.
Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }
One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }
"
+ "FieldToMatch$SingleQueryArgument": "
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.
Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
",
+ "base": "
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
"
+ "Statement$SizeConstraintStatement": "
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
"
}
},
"SqliMatchStatement": {
- "base": "
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
",
+ "base": "
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
",
"refs": {
- "Statement$SqliMatchStatement": "
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
"
+ "Statement$SqliMatchStatement": "
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
"
}
},
"Statement": {
- "base": "
The processing guidance for a Rule, used by AWS WAF to determine whether a web request matches the rule.
",
+ "base": "
The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.
An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
",
"NotStatement$Statement": "
The statement to negate. You can use any statement that can be nested.
",
- "RateBasedStatement$ScopeDownStatement": "
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
",
+ "base": "
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
The collection of tagging definitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
",
+ "base": "
The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
"
+ "TextTransformation$Priority": "
Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
Replaces (ampersand)quot; with \"
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a \"less than\" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
"
+ "TextTransformation$Type": "
You can specify the following transformation types:
BASE64_DECODE - Decode a Base64-encoded string.
BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid.
CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.
Delete the following characters: \\ \" ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32):
\\f, formfeed, decimal 12
\\t, tab, decimal 9
\\n, newline, decimal 10
\\r, carriage return, decimal 13
\\v, vertical tab, decimal 11
Non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\\vascript for javascript.
ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings that aren't valid remain in the output.
HEX_DECODE - Decode a string of hexadecimal characters into a binary.
HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations:
Replaces (ampersand)quot; with \"
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a \"less than\" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters
JS_DECODE - Decode JavaScript escape sequences. If a \\uHHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information.
LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).
MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.
NONE - Specify NONE if you don't want any text transformations.
NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.
NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes.
REMOVE_NULLS - Remove all NULL bytes from the input.
REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.
REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).
SQL_HEX_DECODE - Decode the following ANSI C escape sequences: \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings that aren't valid remain in the output.
URL_DECODE - Decode a URL-encoded value.
URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.
UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
",
- "SqliMatchStatement$TextTransformations": "
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
",
- "XssMatchStatement$TextTransformations": "
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
"
+ "ByteMatchStatement$TextTransformations": "
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
",
+ "SqliMatchStatement$TextTransformations": "
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
",
+ "XssMatchStatement$TextTransformations": "
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.
"
}
},
"TimeWindow": {
- "base": "
In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.
You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.
",
+ "base": "
In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests.
You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request.
The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, AWS WAF sets it to three hours ago.
",
- "GetSampledRequestsResponse$TimeWindow": "
Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
"
+ "GetSampledRequestsRequest$TimeWindow": "
The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
",
+ "GetSampledRequestsResponse$TimeWindow": "
Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
",
- "TimeWindow$StartTime": "
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
",
- "TimeWindow$EndTime": "
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
"
+ "SampledHTTPRequest$Timestamp": "
The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
",
+ "TimeWindow$StartTime": "
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
",
+ "TimeWindow$EndTime": "
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. WAF rejects any extra actions or wildcard actions in the policy.
AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
",
+ "base": "
WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an account. For more information, see Limits in the WAF Developer Guide.
AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
",
+ "base": "
WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
",
+ "base": "
WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
",
+ "base": "
WAF couldn’t retrieve the resource that you requested. Retry your request.
",
"refs": {
}
},
"WebACL": {
- "base": "
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.
",
+ "base": "
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
",
+ "base": "
A rule statement that defines a cross-site scripting (XSS) match search for WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want WAF to search and text transformations to use on the search area before WAF searches for character sequences that are likely to be malicious strings.
",
"refs": {
- "Statement$XssMatchStatement": "
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
"
+ "Statement$XssMatchStatement": "
A rule statement that defines a cross-site scripting (XSS) match search for WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want WAF to search and text transformations to use on the search area before WAF searches for character sequences that are likely to be malicious strings.
"
}
}
}
diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json
index def32d2ebbb..2313783f029 100644
--- a/models/endpoints/endpoints.json
+++ b/models/endpoints/endpoints.json
@@ -4691,6 +4691,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
+ "ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@@ -9212,6 +9213,18 @@
},
"mq" : {
"endpoints" : {
+ "fips-us-gov-east-1" : {
+ "credentialScope" : {
+ "region" : "us-gov-east-1"
+ },
+ "hostname" : "mq-fips.us-gov-east-1.amazonaws.com"
+ },
+ "fips-us-gov-west-1" : {
+ "credentialScope" : {
+ "region" : "us-gov-west-1"
+ },
+ "hostname" : "mq-fips.us-gov-west-1.amazonaws.com"
+ },
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
diff --git a/service/chime/api.go b/service/chime/api.go
index 93e12956b3a..2f0f86e7535 100644
--- a/service/chime/api.go
+++ b/service/chime/api.go
@@ -972,7 +972,7 @@ func (c *Chime) BatchUnsuspendUserRequest(input *BatchUnsuspendUserInput) (req *
// Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts
// can be unsuspended using this action. For more information about different
// account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)
-// in the Amazon Chime Administration Guide.
+// in the account types, in the Amazon Chime Administration Guide.
//
// Previously suspended users who are unsuspended using this action are returned
// to Registered status. Users who are not previously suspended are ignored.
@@ -9173,7 +9173,7 @@ func (c *Chime) GetRetentionSettingsRequest(input *GetRetentionSettingsInput) (r
// Gets the retention settings for the specified Amazon Chime Enterprise account.
// For more information about retention settings, see Managing Chat Retention
// Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html)
-// in the Amazon Chime Administration Guide .
+// in the Amazon Chime Administration Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -11569,7 +11569,7 @@ func (c *Chime) ListAttendeesRequest(input *ListAttendeesInput) (req *request.Re
//
// Lists the attendees for the specified Amazon Chime SDK meeting. For more
// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html)
-// in the Amazon Chime Developer Guide .
+// in the Amazon Chime Developer Guide.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -33517,6 +33517,9 @@ type MediaPlacement struct {
// The audio host URL.
AudioHostUrl *string `type:"string"`
+ // The event ingestion URL.
+ EventIngestionUrl *string `type:"string"`
+
// The screen data URL.
ScreenDataUrl *string `type:"string"`
@@ -33555,6 +33558,12 @@ func (s *MediaPlacement) SetAudioHostUrl(v string) *MediaPlacement {
return s
}
+// SetEventIngestionUrl sets the EventIngestionUrl field's value.
+func (s *MediaPlacement) SetEventIngestionUrl(v string) *MediaPlacement {
+ s.EventIngestionUrl = &v
+ return s
+}
+
// SetScreenDataUrl sets the ScreenDataUrl field's value.
func (s *MediaPlacement) SetScreenDataUrl(v string) *MediaPlacement {
s.ScreenDataUrl = &v
diff --git a/service/cloud9/examples_test.go b/service/cloud9/examples_test.go
index ed7ed7c769c..c39fe027f1c 100644
--- a/service/cloud9/examples_test.go
+++ b/service/cloud9/examples_test.go
@@ -200,7 +200,7 @@ func ExampleCloud9_DeleteEnvironmentMembership_shared00() {
// DescribeEnvironmentMemberships1
//
// The following example gets information about all of the environment members for the
-// specified &AWS; Cloud9 development environment.
+// specified development environment.
func ExampleCloud9_DescribeEnvironmentMemberships_shared00() {
svc := cloud9.New(session.New())
input := &cloud9.DescribeEnvironmentMembershipsInput{
@@ -241,8 +241,8 @@ func ExampleCloud9_DescribeEnvironmentMemberships_shared00() {
// DescribeEnvironmentMemberships2
//
-// The following example gets information about the owner of the specified &AWS; Cloud9
-// development environment.
+// The following example gets information about the owner of the specified development
+// environment.
func ExampleCloud9_DescribeEnvironmentMemberships_shared01() {
svc := cloud9.New(session.New())
input := &cloud9.DescribeEnvironmentMembershipsInput{
@@ -286,8 +286,8 @@ func ExampleCloud9_DescribeEnvironmentMemberships_shared01() {
// DescribeEnvironmentMemberships3
//
-// The following example gets &AWS; Cloud9 development environment membership information
-// for the specified user.
+// The following example gets development environment membership information for the
+// specified user.
func ExampleCloud9_DescribeEnvironmentMemberships_shared02() {
svc := cloud9.New(session.New())
input := &cloud9.DescribeEnvironmentMembershipsInput{
diff --git a/service/codebuild/api.go b/service/codebuild/api.go
index c8c16b86063..cb2fd11f241 100644
--- a/service/codebuild/api.go
+++ b/service/codebuild/api.go
@@ -545,11 +545,12 @@ func (c *CodeBuild) CreateProjectRequest(input *CreateProjectInput) (req *reques
// The input value that was provided is not valid.
//
// * ResourceAlreadyExistsException
-// The specified AWS resource cannot be created, because an AWS resource with
-// the same settings already exists.
+// The specified Amazon Web Services resource cannot be created, because an
+// Amazon Web Services resource with the same settings already exists.
//
// * AccountLimitExceededException
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/CreateProject
func (c *CodeBuild) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error) {
@@ -631,11 +632,12 @@ func (c *CodeBuild) CreateReportGroupRequest(input *CreateReportGroupInput) (req
// The input value that was provided is not valid.
//
// * ResourceAlreadyExistsException
-// The specified AWS resource cannot be created, because an AWS resource with
-// the same settings already exists.
+// The specified Amazon Web Services resource cannot be created, because an
+// Amazon Web Services resource with the same settings already exists.
//
// * AccountLimitExceededException
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/CreateReportGroup
func (c *CodeBuild) CreateReportGroup(input *CreateReportGroupInput) (*CreateReportGroupOutput, error) {
@@ -703,18 +705,17 @@ func (c *CodeBuild) CreateWebhookRequest(input *CreateWebhookInput) (req *reques
// CreateWebhook API operation for AWS CodeBuild.
//
-// For an existing AWS CodeBuild build project that has its source code stored
-// in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding
-// the source code every time a code change is pushed to the repository.
+// For an existing CodeBuild build project that has its source code stored in
+// a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the
+// source code every time a code change is pushed to the repository.
//
-// If you enable webhooks for an AWS CodeBuild project, and the project is used
-// as a build step in AWS CodePipeline, then two identical builds are created
-// for each commit. One build is triggered through webhooks, and one through
-// AWS CodePipeline. Because billing is on a per-build basis, you are billed
-// for both builds. Therefore, if you are using AWS CodePipeline, we recommend
-// that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console,
-// clear the Webhook box. For more information, see step 5 in Change a Build
-// Project's Settings (https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console).
+// If you enable webhooks for an CodeBuild project, and the project is used
+// as a build step in CodePipeline, then two identical builds are created for
+// each commit. One build is triggered through webhooks, and one through CodePipeline.
+// Because billing is on a per-build basis, you are billed for both builds.
+// Therefore, if you are using CodePipeline, we recommend that you disable webhooks
+// in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information,
+// see step 5 in Change a Build Project's Settings (https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -731,11 +732,11 @@ func (c *CodeBuild) CreateWebhookRequest(input *CreateWebhookInput) (req *reques
// There was a problem with the underlying OAuth provider.
//
// * ResourceAlreadyExistsException
-// The specified AWS resource cannot be created, because an AWS resource with
-// the same settings already exists.
+// The specified Amazon Web Services resource cannot be created, because an
+// Amazon Web Services resource with the same settings already exists.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/CreateWebhook
func (c *CodeBuild) CreateWebhook(input *CreateWebhookInput) (*CreateWebhookOutput, error) {
@@ -1217,7 +1218,7 @@ func (c *CodeBuild) DeleteSourceCredentialsRequest(input *DeleteSourceCredential
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/DeleteSourceCredentials
func (c *CodeBuild) DeleteSourceCredentials(input *DeleteSourceCredentialsInput) (*DeleteSourceCredentialsOutput, error) {
@@ -1286,9 +1287,9 @@ func (c *CodeBuild) DeleteWebhookRequest(input *DeleteWebhookInput) (req *reques
// DeleteWebhook API operation for AWS CodeBuild.
//
-// For an existing AWS CodeBuild build project that has its source code stored
-// in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding
-// the source code every time a code change is pushed to the repository.
+// For an existing CodeBuild build project that has its source code stored in
+// a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source
+// code every time a code change is pushed to the repository.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1302,7 +1303,7 @@ func (c *CodeBuild) DeleteWebhookRequest(input *DeleteWebhookInput) (req *reques
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * OAuthProviderException
// There was a problem with the underlying OAuth provider.
@@ -1530,7 +1531,7 @@ func (c *CodeBuild) DescribeTestCasesRequest(input *DescribeTestCasesInput) (req
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/DescribeTestCases
func (c *CodeBuild) DescribeTestCases(input *DescribeTestCasesInput) (*DescribeTestCasesOutput, error) {
@@ -1664,7 +1665,7 @@ func (c *CodeBuild) GetReportGroupTrendRequest(input *GetReportGroupTrendInput)
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/GetReportGroupTrend
func (c *CodeBuild) GetReportGroupTrend(input *GetReportGroupTrendInput) (*GetReportGroupTrendOutput, error) {
@@ -1743,7 +1744,7 @@ func (c *CodeBuild) GetResourcePolicyRequest(input *GetResourcePolicyInput) (req
//
// Returned Error Types:
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * InvalidInputException
// The input value that was provided is not valid.
@@ -1814,8 +1815,8 @@ func (c *CodeBuild) ImportSourceCredentialsRequest(input *ImportSourceCredential
// ImportSourceCredentials API operation for AWS CodeBuild.
//
-// Imports the source repository credentials for an AWS CodeBuild project that
-// has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
+// Imports the source repository credentials for an CodeBuild project that has
+// its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1829,11 +1830,12 @@ func (c *CodeBuild) ImportSourceCredentialsRequest(input *ImportSourceCredential
// The input value that was provided is not valid.
//
// * AccountLimitExceededException
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
//
// * ResourceAlreadyExistsException
-// The specified AWS resource cannot be created, because an AWS resource with
-// the same settings already exists.
+// The specified Amazon Web Services resource cannot be created, because an
+// Amazon Web Services resource with the same settings already exists.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ImportSourceCredentials
func (c *CodeBuild) ImportSourceCredentials(input *ImportSourceCredentialsInput) (*ImportSourceCredentialsOutput, error) {
@@ -1916,7 +1918,7 @@ func (c *CodeBuild) InvalidateProjectCacheRequest(input *InvalidateProjectCacheI
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/InvalidateProjectCache
func (c *CodeBuild) InvalidateProjectCache(input *InvalidateProjectCacheInput) (*InvalidateProjectCacheOutput, error) {
@@ -2141,7 +2143,7 @@ func (c *CodeBuild) ListBuildBatchesForProjectRequest(input *ListBuildBatchesFor
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ListBuildBatchesForProject
func (c *CodeBuild) ListBuildBatchesForProject(input *ListBuildBatchesForProjectInput) (*ListBuildBatchesForProjectOutput, error) {
@@ -2419,7 +2421,7 @@ func (c *CodeBuild) ListBuildsForProjectRequest(input *ListBuildsForProjectInput
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ListBuildsForProject
func (c *CodeBuild) ListBuildsForProject(input *ListBuildsForProjectInput) (*ListBuildsForProjectOutput, error) {
@@ -2539,7 +2541,7 @@ func (c *CodeBuild) ListCuratedEnvironmentImagesRequest(input *ListCuratedEnviro
// ListCuratedEnvironmentImages API operation for AWS CodeBuild.
//
-// Gets information about Docker images that are managed by AWS CodeBuild.
+// Gets information about Docker images that are managed by CodeBuild.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2757,7 +2759,8 @@ func (c *CodeBuild) ListReportGroupsRequest(input *ListReportGroupsInput) (req *
// ListReportGroups API operation for AWS CodeBuild.
//
-// Gets a list ARNs for the report groups in the current AWS account.
+// Gets a list ARNs for the report groups in the current Amazon Web Services
+// account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2894,7 +2897,8 @@ func (c *CodeBuild) ListReportsRequest(input *ListReportsInput) (req *request.Re
// ListReports API operation for AWS CodeBuild.
//
-// Returns a list of ARNs for the reports in the current AWS account.
+// Returns a list of ARNs for the reports in the current Amazon Web Services
+// account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3045,7 +3049,7 @@ func (c *CodeBuild) ListReportsForReportGroupRequest(input *ListReportsForReport
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/ListReportsForReportGroup
func (c *CodeBuild) ListReportsForReportGroup(input *ListReportsForReportGroupInput) (*ListReportsForReportGroupOutput, error) {
@@ -3171,7 +3175,8 @@ func (c *CodeBuild) ListSharedProjectsRequest(input *ListSharedProjectsInput) (r
// ListSharedProjects API operation for AWS CodeBuild.
//
-// Gets a list of projects that are shared with other AWS accounts or users.
+// Gets a list of projects that are shared with other Amazon Web Services accounts
+// or users.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3308,7 +3313,8 @@ func (c *CodeBuild) ListSharedReportGroupsRequest(input *ListSharedReportGroupsI
// ListSharedReportGroups API operation for AWS CodeBuild.
//
-// Gets a list of report groups that are shared with other AWS accounts or users.
+// Gets a list of report groups that are shared with other Amazon Web Services
+// accounts or users.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3529,7 +3535,7 @@ func (c *CodeBuild) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req
//
// Returned Error Types:
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * InvalidInputException
// The input value that was provided is not valid.
@@ -3614,10 +3620,11 @@ func (c *CodeBuild) RetryBuildRequest(input *RetryBuildInput) (req *request.Requ
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * AccountLimitExceededException
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/RetryBuild
func (c *CodeBuild) RetryBuild(input *RetryBuildInput) (*RetryBuildOutput, error) {
@@ -3700,7 +3707,7 @@ func (c *CodeBuild) RetryBuildBatchRequest(input *RetryBuildBatchInput) (req *re
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/RetryBuildBatch
func (c *CodeBuild) RetryBuildBatch(input *RetryBuildBatchInput) (*RetryBuildBatchOutput, error) {
@@ -3782,10 +3789,11 @@ func (c *CodeBuild) StartBuildRequest(input *StartBuildInput) (req *request.Requ
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * AccountLimitExceededException
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/StartBuild
func (c *CodeBuild) StartBuild(input *StartBuildInput) (*StartBuildOutput, error) {
@@ -3867,7 +3875,7 @@ func (c *CodeBuild) StartBuildBatchRequest(input *StartBuildBatchInput) (req *re
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/StartBuildBatch
func (c *CodeBuild) StartBuildBatch(input *StartBuildBatchInput) (*StartBuildBatchOutput, error) {
@@ -3949,7 +3957,7 @@ func (c *CodeBuild) StopBuildRequest(input *StopBuildInput) (req *request.Reques
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/StopBuild
func (c *CodeBuild) StopBuild(input *StopBuildInput) (*StopBuildOutput, error) {
@@ -4031,7 +4039,7 @@ func (c *CodeBuild) StopBuildBatchRequest(input *StopBuildBatchInput) (req *requ
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/StopBuildBatch
func (c *CodeBuild) StopBuildBatch(input *StopBuildBatchInput) (*StopBuildBatchOutput, error) {
@@ -4113,7 +4121,7 @@ func (c *CodeBuild) UpdateProjectRequest(input *UpdateProjectInput) (req *reques
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/UpdateProject
func (c *CodeBuild) UpdateProject(input *UpdateProjectInput) (*UpdateProjectOutput, error) {
@@ -4195,7 +4203,7 @@ func (c *CodeBuild) UpdateReportGroupRequest(input *UpdateReportGroupInput) (req
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06/UpdateReportGroup
func (c *CodeBuild) UpdateReportGroup(input *UpdateReportGroupInput) (*UpdateReportGroupOutput, error) {
@@ -4263,7 +4271,7 @@ func (c *CodeBuild) UpdateWebhookRequest(input *UpdateWebhookInput) (req *reques
// UpdateWebhook API operation for AWS CodeBuild.
//
-// Updates the webhook associated with an AWS CodeBuild build project.
+// Updates the webhook associated with an CodeBuild build project.
//
// If you use Bitbucket for your repository, rotateSecret is ignored.
//
@@ -4279,7 +4287,7 @@ func (c *CodeBuild) UpdateWebhookRequest(input *UpdateWebhookInput) (req *reques
// The input value that was provided is not valid.
//
// * ResourceNotFoundException
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
//
// * OAuthProviderException
// There was a problem with the underlying OAuth provider.
@@ -4306,7 +4314,8 @@ func (c *CodeBuild) UpdateWebhookWithContext(ctx aws.Context, input *UpdateWebho
return out, req.Send()
}
-// An AWS service limit was exceeded for the calling AWS account.
+// An Amazon Web Services service limit was exceeded for the calling Amazon
+// Web Services account.
type AccountLimitExceededException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -4582,8 +4591,8 @@ type BatchGetProjectsInput struct {
_ struct{} `type:"structure"`
// The names or ARNs of the build projects. To get information about a project
- // shared with your AWS account, its ARN must be specified. You cannot specify
- // a shared project using its name.
+ // shared with your Amazon Web Services account, its ARN must be specified.
+ // You cannot specify a shared project using its name.
//
// Names is a required field
Names []*string `locationName:"names" min:"1" type:"list" required:"true"`
@@ -4807,7 +4816,7 @@ type BatchRestrictions struct {
// An array of strings that specify the compute types that are allowed for the
// batch build. See Build environment compute types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html)
- // in the AWS CodeBuild User Guide for these values.
+ // in the CodeBuild User Guide for these values.
ComputeTypesAllowed []*string `locationName:"computeTypesAllowed" type:"list"`
// Specifies the maximum number of builds allowed.
@@ -4881,8 +4890,8 @@ type Build struct {
// Contains information about the debug session for this build.
DebugSession *DebugSession `locationName:"debugSession" type:"structure"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be
- // used for encrypting the build output artifacts.
+ // The Key Management Service customer master key (CMK) to be used for encrypting
+ // the build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -4899,11 +4908,11 @@ type Build struct {
// A list of exported environment variables for this build.
//
- // Exported environment variables are used in conjunction with AWS CodePipeline
+ // Exported environment variables are used in conjunction with CodePipeline
// to export environment variables from the current build stage to subsequent
// stages in the pipeline. For more information, see Working with variables
// (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html)
- // in the AWS CodePipeline User Guide.
+ // in the CodePipeline User Guide.
ExportedEnvironmentVariables []*ExportedEnvironmentVariable `locationName:"exportedEnvironmentVariables" type:"list"`
// An array of ProjectFileSystemLocation objects for a CodeBuild build project.
@@ -4916,17 +4925,16 @@ type Build struct {
// The entity that started the build. Valid values include:
//
- // * If AWS CodePipeline started the build, the pipeline's name (for example,
+ // * If CodePipeline started the build, the pipeline's name (for example,
// codepipeline/my-demo-pipeline).
//
- // * If an AWS Identity and Access Management (IAM) user started the build,
- // the user's name (for example, MyUserName).
+ // * If an Identity and Access Management user started the build, the user's
+ // name (for example, MyUserName).
//
- // * If the Jenkins plugin for AWS CodeBuild started the build, the string
- // CodeBuild-Jenkins-Plugin.
+ // * If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
Initiator *string `locationName:"initiator" type:"string"`
- // Information about the build's logs in Amazon CloudWatch Logs.
+ // Information about the build's logs in CloudWatch Logs.
Logs *LogsLocation `locationName:"logs" type:"structure"`
// Describes a network interface.
@@ -4936,7 +4944,7 @@ type Build struct {
// about any current build phase that is not yet complete.
Phases []*BuildPhase `locationName:"phases" type:"list"`
- // The name of the AWS CodeBuild project.
+ // The name of the CodeBuild project.
ProjectName *string `locationName:"projectName" min:"1" type:"string"`
// The number of minutes a build is allowed to be queued before it times out.
@@ -4947,10 +4955,10 @@ type Build struct {
// An identifier for the version of this build's source code.
//
- // * For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit
+ // * For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit
// ID.
//
- // * For AWS CodePipeline, the source revision provided by AWS CodePipeline.
+ // * For CodePipeline, the source revision provided by CodePipeline.
//
// * For Amazon S3, this does not apply.
ResolvedSourceVersion *string `locationName:"resolvedSourceVersion" min:"1" type:"string"`
@@ -4961,7 +4969,7 @@ type Build struct {
// An array of ProjectSourceVersion objects. Each ProjectSourceVersion must
// be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -4993,17 +5001,17 @@ type Build struct {
// (at the build level) takes precedence.
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" min:"1" type:"string"`
// When the build process started, expressed in Unix time format.
StartTime *time.Time `locationName:"startTime" type:"timestamp"`
- // How long, in minutes, for AWS CodeBuild to wait before timing out this build
+ // How long, in minutes, for CodeBuild to wait before timing out this build
// if it does not get marked as completed.
TimeoutInMinutes *int64 `locationName:"timeoutInMinutes" type:"integer"`
- // If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide
+ // If your CodeBuild project accesses resources in an Amazon VPC, you provide
// this parameter that identifies the VPC ID and the list of security group
// IDs and subnet IDs. The security groups and subnets must belong to the same
// VPC. You must provide at least one security group and one subnet ID.
@@ -5219,38 +5227,6 @@ type BuildArtifacts struct {
// An identifier for this artifact definition.
ArtifactIdentifier *string `locationName:"artifactIdentifier" type:"string"`
- // Specifies the access for objects that are uploaded to an Amazon S3 bucket
- // that is owned by another account.
- //
- // By default, only the account that uploads the objects to the bucket has access
- // to these objects. This property allows you to give the bucket owner access
- // to these objects.
- //
- // NONE
- //
- // The bucket owner does not have access to the objects. This is the default.
- //
- // READ_ONLY
- //
- // The bucket owner has read only access to the objects. The uploading account
- // retains ownership of the objects.
- //
- // FULL
- //
- // The bucket owner has full access to the objects. Object ownership is determined
- // by the following criteria:
- //
- // * If the bucket is configured with the Bucket owner preferred setting,
- // the bucket owner owns the objects. The uploading account will have object
- // access as specified by the bucket's policy.
- //
- // * Otherwise, the uploading account retains ownership of the objects.
- //
- // For more information about Amazon S3 object ownership, see Controlling ownership
- // of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
- // in the Amazon Simple Storage Service User Guide.
- BucketOwnerAccess *string `locationName:"bucketOwnerAccess" type:"string" enum:"BucketOwnerAccess"`
-
// Information that tells you if encryption for build artifacts is disabled.
EncryptionDisabled *bool `locationName:"encryptionDisabled" type:"boolean"`
@@ -5298,12 +5274,6 @@ func (s *BuildArtifacts) SetArtifactIdentifier(v string) *BuildArtifacts {
return s
}
-// SetBucketOwnerAccess sets the BucketOwnerAccess field's value.
-func (s *BuildArtifacts) SetBucketOwnerAccess(v string) *BuildArtifacts {
- s.BucketOwnerAccess = &v
- return s
-}
-
// SetEncryptionDisabled sets the EncryptionDisabled field's value.
func (s *BuildArtifacts) SetEncryptionDisabled(v bool) *BuildArtifacts {
s.EncryptionDisabled = &v
@@ -5378,8 +5348,8 @@ type BuildBatch struct {
// Batch session debugging is not supported for matrix batch builds.
DebugSessionEnabled *bool `locationName:"debugSessionEnabled" type:"boolean"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be
- // used for encrypting the batch build output artifacts.
+ // The Key Management Service customer master key (CMK) to be used for encrypting
+ // the batch build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -5404,17 +5374,16 @@ type BuildBatch struct {
// The entity that started the batch build. Valid values include:
//
- // * If AWS CodePipeline started the build, the pipeline's name (for example,
+ // * If CodePipeline started the build, the pipeline's name (for example,
// codepipeline/my-demo-pipeline).
//
- // * If an AWS Identity and Access Management (IAM) user started the build,
- // the user's name.
+ // * If an Identity and Access Management user started the build, the user's
+ // name.
//
- // * If the Jenkins plugin for AWS CodeBuild started the build, the string
- // CodeBuild-Jenkins-Plugin.
+ // * If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
Initiator *string `locationName:"initiator" type:"string"`
- // Information about logs for a build project. These can be logs in Amazon CloudWatch
+ // Information about logs for a build project. These can be logs in CloudWatch
// Logs, built in a specified S3 bucket, or both.
LogConfig *LogsConfig `locationName:"logConfig" type:"structure"`
@@ -5430,10 +5399,10 @@ type BuildBatch struct {
// The identifier of the resolved version of this batch build's source code.
//
- // * For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit
+ // * For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit
// ID.
//
- // * For AWS CodePipeline, the source revision provided by AWS CodePipeline.
+ // * For CodePipeline, the source revision provided by CodePipeline.
//
// * For Amazon S3, this does not apply.
ResolvedSourceVersion *string `locationName:"resolvedSourceVersion" min:"1" type:"string"`
@@ -5445,7 +5414,7 @@ type BuildBatch struct {
// An array of ProjectSourceVersion objects. Each ProjectSourceVersion must
// be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -5478,7 +5447,7 @@ type BuildBatch struct {
// The date and time that the batch build started.
StartTime *time.Time `locationName:"startTime" type:"timestamp"`
- // Information about the VPC configuration that AWS CodeBuild accesses.
+ // Information about the VPC configuration that CodeBuild accesses.
VpcConfig *VpcConfig `locationName:"vpcConfig" type:"structure"`
}
@@ -6044,7 +6013,7 @@ func (s *BuildPhase) SetStartTime(v time.Time) *BuildPhase {
return s
}
-// Contains information that defines how the AWS CodeBuild build project reports
+// Contains information that defines how the CodeBuild build project reports
// the build status to the source provider.
type BuildStatusConfig struct {
_ struct{} `type:"structure"`
@@ -6190,25 +6159,25 @@ func (s *BuildSummary) SetSecondaryArtifacts(v []*ResolvedArtifact) *BuildSummar
return s
}
-// Information about Amazon CloudWatch Logs for a build project.
+// Information about CloudWatch Logs for a build project.
type CloudWatchLogsConfig struct {
_ struct{} `type:"structure"`
- // The group name of the logs in Amazon CloudWatch Logs. For more information,
- // see Working with Log Groups and Log Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).
+ // The group name of the logs in CloudWatch Logs. For more information, see
+ // Working with Log Groups and Log Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).
GroupName *string `locationName:"groupName" type:"string"`
- // The current status of the logs in Amazon CloudWatch Logs for a build project.
- // Valid values are:
+ // The current status of the logs in CloudWatch Logs for a build project. Valid
+ // values are:
//
- // * ENABLED: Amazon CloudWatch Logs are enabled for this build project.
+ // * ENABLED: CloudWatch Logs are enabled for this build project.
//
- // * DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
+ // * DISABLED: CloudWatch Logs are not enabled for this build project.
//
// Status is a required field
Status *string `locationName:"status" type:"string" required:"true" enum:"LogsConfigStatusType"`
- // The prefix of the stream name of the Amazon CloudWatch Logs. For more information,
+ // The prefix of the stream name of the CloudWatch Logs. For more information,
// see Working with Log Groups and Log Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).
StreamName *string `locationName:"streamName" type:"string"`
}
@@ -6470,8 +6439,8 @@ type CreateProjectInput struct {
// A description that makes the build project easy to identify.
Description *string `locationName:"description" type:"string"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be
- // used for encrypting the build output artifacts.
+ // The Key Management Service customer master key (CMK) to be used for encrypting
+ // the build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -6490,8 +6459,8 @@ type CreateProjectInput struct {
// mountPoint, and type of a file system created using Amazon Elastic File System.
FileSystemLocations []*ProjectFileSystemLocation `locationName:"fileSystemLocations" type:"list"`
- // Information about logs for the build project. These can be logs in Amazon
- // CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
+ // Information about logs for the build project. These can be logs in CloudWatch
+ // Logs, logs uploaded to a specified S3 bucket, or both.
LogsConfig *LogsConfig `locationName:"logsConfig" type:"structure"`
// The name of the build project.
@@ -6513,9 +6482,9 @@ type CreateProjectInput struct {
// An array of ProjectSource objects.
SecondarySources []*ProjectSource `locationName:"secondarySources" type:"list"`
- // The ARN of the AWS Identity and Access Management (IAM) role that enables
- // AWS CodeBuild to interact with dependent AWS services on behalf of the AWS
- // account.
+ // The ARN of the Identity and Access Management role that enables CodeBuild
+ // to interact with dependent Amazon Web Services services on behalf of the
+ // Amazon Web Services account.
//
// ServiceRole is a required field
ServiceRole *string `locationName:"serviceRole" min:"1" type:"string" required:"true"`
@@ -6528,7 +6497,7 @@ type CreateProjectInput struct {
// A version of the build input to be built for this project. If not specified,
// the latest version is used. If specified, it must be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -6549,21 +6518,21 @@ type CreateProjectInput struct {
// precedence over this sourceVersion (at the project level).
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" type:"string"`
// A list of tag key and value pairs associated with this build project.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // build project tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild build project tags.
Tags []*Tag `locationName:"tags" type:"list"`
- // How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait
- // before it times out any build that has not been marked as completed. The
- // default is 60 minutes.
+ // How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before
+ // it times out any build that has not been marked as completed. The default
+ // is 60 minutes.
TimeoutInMinutes *int64 `locationName:"timeoutInMinutes" min:"5" type:"integer"`
- // VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
+ // VpcConfig enables CodeBuild to access resources in an Amazon VPC.
VpcConfig *VpcConfig `locationName:"vpcConfig" type:"structure"`
}
@@ -6857,8 +6826,8 @@ type CreateReportGroupInput struct {
// A list of tag key and value pairs associated with this report group.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // report group tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild report group tags.
Tags []*Tag `locationName:"tags" type:"list"`
// The type of report group.
@@ -6983,7 +6952,7 @@ type CreateWebhookInput struct {
// array must pass. For a filter group to pass, each of its filters must pass.
FilterGroups [][]*WebhookFilter `locationName:"filterGroups" type:"list"`
- // The name of the AWS CodeBuild project.
+ // The name of the CodeBuild project.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"2" type:"string" required:"true"`
@@ -7043,7 +7012,7 @@ type CreateWebhookOutput struct {
_ struct{} `type:"structure"`
// Information about a webhook that connects repository events to a build project
- // in AWS CodeBuild.
+ // in CodeBuild.
Webhook *Webhook `locationName:"webhook" type:"structure"`
}
@@ -7486,7 +7455,7 @@ func (s *DeleteSourceCredentialsOutput) SetArn(v string) *DeleteSourceCredential
type DeleteWebhookInput struct {
_ struct{} `type:"structure"`
- // The name of the AWS CodeBuild project.
+ // The name of the CodeBuild project.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"2" type:"string" required:"true"`
@@ -7793,7 +7762,7 @@ func (s *DescribeTestCasesOutput) SetTestCases(v []*TestCase) *DescribeTestCases
return s
}
-// Information about a Docker image that is managed by AWS CodeBuild.
+// Information about a Docker image that is managed by CodeBuild.
type EnvironmentImage struct {
_ struct{} `type:"structure"`
@@ -7836,7 +7805,7 @@ func (s *EnvironmentImage) SetVersions(v []*string) *EnvironmentImage {
}
// A set of Docker images that are related by programming language and are managed
-// by AWS CodeBuild.
+// by CodeBuild.
type EnvironmentLanguage struct {
_ struct{} `type:"structure"`
@@ -7869,8 +7838,7 @@ func (s *EnvironmentLanguage) SetLanguage(v string) *EnvironmentLanguage {
return s
}
-// A set of Docker images that are related by platform and are managed by AWS
-// CodeBuild.
+// A set of Docker images that are related by platform and are managed by CodeBuild.
type EnvironmentPlatform struct {
_ struct{} `type:"structure"`
@@ -7914,27 +7882,28 @@ type EnvironmentVariable struct {
// The type of environment variable. Valid values include:
//
- // * PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems
- // Manager Parameter Store. To learn how to specify a parameter store environment
- // variable, see env/parameter-store (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store)
- // in the AWS CodeBuild User Guide.
+ // * PARAMETER_STORE: An environment variable stored in Systems Manager Parameter
+ // Store. To learn how to specify a parameter store environment variable,
+ // see env/parameter-store (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store)
+ // in the CodeBuild User Guide.
//
// * PLAINTEXT: An environment variable in plain text format. This is the
// default value.
//
- // * SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager.
+ // * SECRETS_MANAGER: An environment variable stored in Secrets Manager.
// To learn how to specify a secrets manager environment variable, see env/secrets-manager
// (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
Type *string `locationName:"type" type:"string" enum:"EnvironmentVariableType"`
// The value of the environment variable.
//
// We strongly discourage the use of PLAINTEXT environment variables to store
- // sensitive values, especially AWS secret key IDs and secret access keys. PLAINTEXT
- // environment variables can be displayed in plain text using the AWS CodeBuild
- // console and the AWS Command Line Interface (AWS CLI). For sensitive values,
- // we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
+ // sensitive values, especially Amazon Web Services secret key IDs and secret
+ // access keys. PLAINTEXT environment variables can be displayed in plain text
+ // using the CodeBuild console and the AWS Command Line Interface (AWS CLI).
+ // For sensitive values, we recommend you use an environment variable of type
+ // PARAMETER_STORE or SECRETS_MANAGER.
//
// Value is a required field
Value *string `locationName:"value" type:"string" required:"true"`
@@ -7989,11 +7958,11 @@ func (s *EnvironmentVariable) SetValue(v string) *EnvironmentVariable {
// Contains information about an exported environment variable.
//
-// Exported environment variables are used in conjunction with AWS CodePipeline
+// Exported environment variables are used in conjunction with CodePipeline
// to export environment variables from the current build stage to subsequent
// stages in the pipeline. For more information, see Working with variables
// (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html)
-// in the AWS CodePipeline User Guide.
+// in the CodePipeline User Guide.
//
// During a build, the value of a variable is available starting with the install
// phase. It can be updated between the start of the install phase and the end
@@ -8237,12 +8206,12 @@ func (s *GetResourcePolicyOutput) SetPolicy(v string) *GetResourcePolicyOutput {
return s
}
-// Information about the Git submodules configuration for an AWS CodeBuild build
+// Information about the Git submodules configuration for an CodeBuild build
// project.
type GitSubmodulesConfig struct {
_ struct{} `type:"structure"`
- // Set to true to fetch Git submodules for your AWS CodeBuild build project.
+ // Set to true to fetch Git submodules for your CodeBuild build project.
//
// FetchSubmodules is a required field
FetchSubmodules *bool `locationName:"fetchSubmodules" type:"boolean" required:"true"`
@@ -8282,7 +8251,7 @@ type ImportSourceCredentialsInput struct {
// The type of authentication used to connect to a GitHub, GitHub Enterprise,
// or Bitbucket repository. An OAUTH connection is not supported by the API
- // and must be created using the AWS CodeBuild console.
+ // and must be created using the CodeBuild console.
//
// AuthType is a required field
AuthType *string `locationName:"authType" type:"string" required:"true" enum:"AuthType"`
@@ -8455,7 +8424,7 @@ func (s *InvalidInputException) RequestID() string {
type InvalidateProjectCacheInput struct {
_ struct{} `type:"structure"`
- // The name of the AWS CodeBuild build project that the cache is reset for.
+ // The name of the CodeBuild build project that the cache is reset for.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
@@ -8737,7 +8706,7 @@ type ListBuildsForProjectInput struct {
// more next tokens are returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The name of the AWS CodeBuild project.
+ // The name of the CodeBuild project.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
@@ -8930,7 +8899,7 @@ type ListCuratedEnvironmentImagesOutput struct {
_ struct{} `type:"structure"`
// Information about supported platforms for Docker images that are managed
- // by AWS CodeBuild.
+ // by CodeBuild.
Platforms []*EnvironmentPlatform `locationName:"platforms" type:"list"`
}
@@ -9151,7 +9120,8 @@ type ListReportGroupsOutput struct {
// returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The list of ARNs for the report groups in the current AWS account.
+ // The list of ARNs for the report groups in the current Amazon Web Services
+ // account.
ReportGroups []*string `locationName:"reportGroups" min:"1" type:"list"`
}
@@ -9390,7 +9360,8 @@ type ListReportsOutput struct {
// returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The list of returned ARNs for the reports in the current AWS account.
+ // The list of returned ARNs for the reports in the current Amazon Web Services
+ // account.
Reports []*string `locationName:"reports" min:"1" type:"list"`
}
@@ -9433,8 +9404,8 @@ type ListSharedProjectsInput struct {
// returned.
NextToken *string `locationName:"nextToken" min:"1" type:"string"`
- // The criterion to be used to list build projects shared with the current AWS
- // account or user. Valid values include:
+ // The criterion to be used to list build projects shared with the current Amazon
+ // Web Services account or user. Valid values include:
//
// * ARN: List based on the ARN.
//
@@ -9512,8 +9483,8 @@ type ListSharedProjectsOutput struct {
// returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The list of ARNs for the build projects shared with the current AWS account
- // or user.
+ // The list of ARNs for the build projects shared with the current Amazon Web
+ // Services account or user.
Projects []*string `locationName:"projects" min:"1" type:"list"`
}
@@ -9556,8 +9527,8 @@ type ListSharedReportGroupsInput struct {
// returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The criterion to be used to list report groups shared with the current AWS
- // account or user. Valid values include:
+ // The criterion to be used to list report groups shared with the current Amazon
+ // Web Services account or user. Valid values include:
//
// * ARN: List based on the ARN.
//
@@ -9632,8 +9603,8 @@ type ListSharedReportGroupsOutput struct {
// returned.
NextToken *string `locationName:"nextToken" type:"string"`
- // The list of ARNs for the report groups shared with the current AWS account
- // or user.
+ // The list of ARNs for the report groups shared with the current Amazon Web
+ // Services account or user.
ReportGroups []*string `locationName:"reportGroups" min:"1" type:"list"`
}
@@ -9698,13 +9669,13 @@ func (s *ListSourceCredentialsOutput) SetSourceCredentialsInfos(v []*SourceCrede
return s
}
-// Information about logs for a build project. These can be logs in Amazon CloudWatch
+// Information about logs for a build project. These can be logs in CloudWatch
// Logs, built in a specified S3 bucket, or both.
type LogsConfig struct {
_ struct{} `type:"structure"`
- // Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch
- // Logs are enabled by default.
+ // Information about CloudWatch Logs for a build project. CloudWatch Logs are
+ // enabled by default.
CloudWatchLogs *CloudWatchLogsConfig `locationName:"cloudWatchLogs" type:"structure"`
// Information about logs built to an S3 bucket for a build project. S3 logs
@@ -9754,21 +9725,21 @@ func (s *LogsConfig) SetS3Logs(v *S3LogsConfig) *LogsConfig {
return s
}
-// Information about build logs in Amazon CloudWatch Logs.
+// Information about build logs in CloudWatch Logs.
type LogsLocation struct {
_ struct{} `type:"structure"`
- // Information about Amazon CloudWatch Logs for a build project.
+ // Information about CloudWatch Logs for a build project.
CloudWatchLogs *CloudWatchLogsConfig `locationName:"cloudWatchLogs" type:"structure"`
- // The ARN of Amazon CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.
- // For more information, see Resources Defined by Amazon CloudWatch Logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies).
+ // The ARN of CloudWatch Logs for a build project. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.
+ // For more information, see Resources Defined by CloudWatch Logs (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies).
CloudWatchLogsArn *string `locationName:"cloudWatchLogsArn" type:"string"`
- // The URL to an individual build log in Amazon CloudWatch Logs.
+ // The URL to an individual build log in CloudWatch Logs.
DeepLink *string `locationName:"deepLink" type:"string"`
- // The name of the Amazon CloudWatch Logs group for the build logs.
+ // The name of the CloudWatch Logs group for the build logs.
GroupName *string `locationName:"groupName" type:"string"`
// The URL to a build log in an S3 bucket.
@@ -9781,7 +9752,7 @@ type LogsLocation struct {
// For more information, see Resources Defined by Amazon S3 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies).
S3LogsArn *string `locationName:"s3LogsArn" type:"string"`
- // The name of the Amazon CloudWatch Logs stream for the build logs.
+ // The name of the CloudWatch Logs stream for the build logs.
StreamName *string `locationName:"streamName" type:"string"`
}
@@ -10000,14 +9971,16 @@ type Project struct {
// A description that makes the build project easy to identify.
Description *string `locationName:"description" type:"string"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be
- // used for encrypting the build output artifacts.
+ // The Key Management Service customer master key (CMK) to be used for encrypting
+ // the build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
//
// You can specify either the Amazon Resource Name (ARN) of the CMK or, if available,
- // the CMK's alias (using the format alias/).
+ // the CMK's alias (using the format alias/). If you don't specify
+ // a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service
+ // (Amazon S3).
EncryptionKey *string `locationName:"encryptionKey" min:"1" type:"string"`
// Information about the build environment for this build project.
@@ -10023,7 +9996,7 @@ type Project struct {
LastModified *time.Time `locationName:"lastModified" type:"timestamp"`
// Information about logs for the build project. A project can create logs in
- // Amazon CloudWatch Logs, an S3 bucket, or both.
+ // CloudWatch Logs, an S3 bucket, or both.
LogsConfig *LogsConfig `locationName:"logsConfig" type:"structure"`
// The name of the build project.
@@ -10043,9 +10016,9 @@ type Project struct {
// An array of ProjectSource objects.
SecondarySources []*ProjectSource `locationName:"secondarySources" type:"list"`
- // The ARN of the AWS Identity and Access Management (IAM) role that enables
- // AWS CodeBuild to interact with dependent AWS services on behalf of the AWS
- // account.
+ // The ARN of the Identity and Access Management role that enables CodeBuild
+ // to interact with dependent Amazon Web Services services on behalf of the
+ // Amazon Web Services account.
ServiceRole *string `locationName:"serviceRole" min:"1" type:"string"`
// Information about the build input source code for this build project.
@@ -10054,7 +10027,7 @@ type Project struct {
// A version of the build input to be built for this project. If not specified,
// the latest version is used. If specified, it must be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -10075,25 +10048,25 @@ type Project struct {
// precedence over this sourceVersion (at the project level).
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" type:"string"`
// A list of tag key and value pairs associated with this build project.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // build project tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild build project tags.
Tags []*Tag `locationName:"tags" type:"list"`
- // How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait
- // before timing out any related build that did not get marked as completed.
- // The default is 60 minutes.
+ // How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before
+ // timing out any related build that did not get marked as completed. The default
+ // is 60 minutes.
TimeoutInMinutes *int64 `locationName:"timeoutInMinutes" min:"5" type:"integer"`
- // Information about the VPC configuration that AWS CodeBuild accesses.
+ // Information about the VPC configuration that CodeBuild accesses.
VpcConfig *VpcConfig `locationName:"vpcConfig" type:"structure"`
// Information about a webhook that connects repository events to a build project
- // in AWS CodeBuild.
+ // in CodeBuild.
Webhook *Webhook `locationName:"webhook" type:"structure"`
}
@@ -10264,38 +10237,6 @@ type ProjectArtifacts struct {
// An identifier for this artifact definition.
ArtifactIdentifier *string `locationName:"artifactIdentifier" type:"string"`
- // Specifies the access for objects that are uploaded to an Amazon S3 bucket
- // that is owned by another account.
- //
- // By default, only the account that uploads the objects to the bucket has access
- // to these objects. This property allows you to give the bucket owner access
- // to these objects.
- //
- // NONE
- //
- // The bucket owner does not have access to the objects. This is the default.
- //
- // READ_ONLY
- //
- // The bucket owner has read only access to the objects. The uploading account
- // retains ownership of the objects.
- //
- // FULL
- //
- // The bucket owner has full access to the objects. Object ownership is determined
- // by the following criteria:
- //
- // * If the bucket is configured with the Bucket owner preferred setting,
- // the bucket owner owns the objects. The uploading account will have object
- // access as specified by the bucket's policy.
- //
- // * Otherwise, the uploading account retains ownership of the objects.
- //
- // For more information about Amazon S3 object ownership, see Controlling ownership
- // of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
- // in the Amazon Simple Storage Service User Guide.
- BucketOwnerAccess *string `locationName:"bucketOwnerAccess" type:"string" enum:"BucketOwnerAccess"`
-
// Set to true if you do not want your output artifacts encrypted. This option
// is valid only if your artifacts type is Amazon S3. If this is set with another
// artifacts type, an invalidInputException is thrown.
@@ -10303,9 +10244,9 @@ type ProjectArtifacts struct {
// Information about the build output artifact location:
//
- // * If type is set to CODEPIPELINE, AWS CodePipeline ignores this value
- // if specified. This is because AWS CodePipeline manages its build output
- // locations instead of AWS CodeBuild.
+ // * If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
+ // This is because CodePipeline manages its build output locations instead
+ // of CodeBuild.
//
// * If type is set to NO_ARTIFACTS, this value is ignored if specified,
// because no build output is produced.
@@ -10313,12 +10254,12 @@ type ProjectArtifacts struct {
// * If type is set to S3, this is the name of the output bucket.
Location *string `locationName:"location" type:"string"`
- // Along with path and namespaceType, the pattern that AWS CodeBuild uses to
- // name and store the output artifact:
+ // Along with path and namespaceType, the pattern that CodeBuild uses to name
+ // and store the output artifact:
//
- // * If type is set to CODEPIPELINE, AWS CodePipeline ignores this value
- // if specified. This is because AWS CodePipeline manages its build output
- // names instead of AWS CodeBuild.
+ // * If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
+ // This is because CodePipeline manages its build output names instead of
+ // CodeBuild.
//
// * If type is set to NO_ARTIFACTS, this value is ignored if specified,
// because no build output is produced.
@@ -10339,12 +10280,12 @@ type ProjectArtifacts struct {
// name is set to "/", the output artifact is stored in MyArtifacts/.
Name *string `locationName:"name" type:"string"`
- // Along with path and name, the pattern that AWS CodeBuild uses to determine
- // the name and location to store the output artifact:
+ // Along with path and name, the pattern that CodeBuild uses to determine the
+ // name and location to store the output artifact:
//
- // * If type is set to CODEPIPELINE, AWS CodePipeline ignores this value
- // if specified. This is because AWS CodePipeline manages its build output
- // names instead of AWS CodeBuild.
+ // * If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
+ // This is because CodePipeline manages its build output names instead of
+ // CodeBuild.
//
// * If type is set to NO_ARTIFACTS, this value is ignored if specified,
// because no build output is produced.
@@ -10365,25 +10306,25 @@ type ProjectArtifacts struct {
// The type of build output artifact to create:
//
- // * If type is set to CODEPIPELINE, AWS CodePipeline ignores this value
- // if specified. This is because AWS CodePipeline manages its build output
- // artifacts instead of AWS CodeBuild.
+ // * If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
+ // This is because CodePipeline manages its build output artifacts instead
+ // of CodeBuild.
//
// * If type is set to NO_ARTIFACTS, this value is ignored if specified,
// because no build output is produced.
//
- // * If type is set to S3, valid values include: NONE: AWS CodeBuild creates
+ // * If type is set to S3, valid values include: NONE: CodeBuild creates
// in the output bucket a folder that contains the build output. This is
- // the default if packaging is not specified. ZIP: AWS CodeBuild creates
- // in the output bucket a ZIP file that contains the build output.
+ // the default if packaging is not specified. ZIP: CodeBuild creates in the
+ // output bucket a ZIP file that contains the build output.
Packaging *string `locationName:"packaging" type:"string" enum:"ArtifactPackaging"`
- // Along with namespaceType and name, the pattern that AWS CodeBuild uses to
- // name and store the output artifact:
+ // Along with namespaceType and name, the pattern that CodeBuild uses to name
+ // and store the output artifact:
//
- // * If type is set to CODEPIPELINE, AWS CodePipeline ignores this value
- // if specified. This is because AWS CodePipeline manages its build output
- // names instead of AWS CodeBuild.
+ // * If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
+ // This is because CodePipeline manages its build output names instead of
+ // CodeBuild.
//
// * If type is set to NO_ARTIFACTS, this value is ignored if specified,
// because no build output is produced.
@@ -10398,8 +10339,8 @@ type ProjectArtifacts struct {
// The type of build output artifact. Valid values include:
//
- // * CODEPIPELINE: The build project has build output generated through AWS
- // CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts.
+ // * CODEPIPELINE: The build project has build output generated through CodePipeline.
+ // The CODEPIPELINE type is not supported for secondaryArtifacts.
//
// * NO_ARTIFACTS: The build project does not produce any build output.
//
@@ -10438,12 +10379,6 @@ func (s *ProjectArtifacts) SetArtifactIdentifier(v string) *ProjectArtifacts {
return s
}
-// SetBucketOwnerAccess sets the BucketOwnerAccess field's value.
-func (s *ProjectArtifacts) SetBucketOwnerAccess(v string) *ProjectArtifacts {
- s.BucketOwnerAccess = &v
- return s
-}
-
// SetEncryptionDisabled sets the EncryptionDisabled field's value.
func (s *ProjectArtifacts) SetEncryptionDisabled(v bool) *ProjectArtifacts {
s.EncryptionDisabled = &v
@@ -10712,7 +10647,7 @@ type ProjectEnvironment struct {
// The ARN of the Amazon S3 bucket, path prefix, and object key that contains
// the PEM-encoded certificate for the build project. For more information,
// see certificate (https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
Certificate *string `locationName:"certificate" type:"string"`
// Information about the compute resources the build project uses. Available
@@ -10741,7 +10676,7 @@ type ProjectEnvironment struct {
// 8 vCPUs on ARM-based processors for builds.
//
// For more information, see Build Environment Compute Types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
//
// ComputeType is a required field
ComputeType *string `locationName:"computeType" type:"string" required:"true" enum:"ComputeType"`
@@ -10761,21 +10696,24 @@ type ProjectEnvironment struct {
// to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,"
// use /@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
//
+ // For more information, see Docker images provided by CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html)
+ // in the CodeBuild user guide.
+ //
// Image is a required field
Image *string `locationName:"image" min:"1" type:"string" required:"true"`
- // The type of credentials AWS CodeBuild uses to pull images in your build.
- // There are two valid values:
+ // The type of credentials CodeBuild uses to pull images in your build. There
+ // are two valid values:
//
- // * CODEBUILD specifies that AWS CodeBuild uses its own credentials. This
- // requires that you modify your ECR repository policy to trust AWS CodeBuild's
- // service principal.
+ // * CODEBUILD specifies that CodeBuild uses its own credentials. This requires
+ // that you modify your ECR repository policy to trust CodeBuild service
+ // principal.
//
- // * SERVICE_ROLE specifies that AWS CodeBuild uses your build project's
- // service role.
+ // * SERVICE_ROLE specifies that CodeBuild uses your build project's service
+ // role.
//
// When you use a cross-account or private registry image, you must use SERVICE_ROLE
- // credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD
+ // credentials. When you use an CodeBuild curated image, you must use CODEBUILD
// credentials.
ImagePullCredentialsType *string `locationName:"imagePullCredentialsType" type:"string" enum:"ImagePullCredentialsType"`
@@ -10825,6 +10763,13 @@ type ProjectEnvironment struct {
// Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China
// (Beijing), and China (Ningxia).
//
+ // * The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER
+ // are available only in regions US East (N. Virginia), US East (Ohio), US
+ // West (Oregon), and EU (Ireland).
+ //
+ // For more information, see Build environment compute types (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html)
+ // in the CodeBuild user guide.
+ //
// Type is a required field
Type *string `locationName:"type" type:"string" required:"true" enum:"EnvironmentType"`
}
@@ -10939,9 +10884,9 @@ type ProjectFileSystemLocation struct {
// A string that specifies the location of the file system created by Amazon
// EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name
- // of file system when you view it in the AWS EFS console. The directory path
- // is a path to a directory in the file system that CodeBuild mounts. For example,
- // if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com,
+ // of file system when you view it in the Amazon EFS console. The directory
+ // path is a path to a directory in the file system that CodeBuild mounts. For
+ // example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com,
// and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
//
// The directory path in the format efs-dns-name:/directory-path is optional.
@@ -10949,7 +10894,7 @@ type ProjectFileSystemLocation struct {
// and CodeBuild mounts the entire file system.
Location *string `locationName:"location" type:"string"`
- // The mount options for a file system created by AWS EFS. The default mount
+ // The mount options for a file system created by Amazon EFS. The default mount
// options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2.
// For more information, see Recommended NFS Mount Options (https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html).
MountOptions *string `locationName:"mountOptions" type:"string"`
@@ -11005,10 +10950,10 @@ func (s *ProjectFileSystemLocation) SetType(v string) *ProjectFileSystemLocation
type ProjectSource struct {
_ struct{} `type:"structure"`
- // Information about the authorization settings for AWS CodeBuild to access
- // the source code to be built.
+ // Information about the authorization settings for CodeBuild to access the
+ // source code to be built.
//
- // This information is for the AWS CodeBuild console's use only. Your code should
+ // This information is for the CodeBuild console's use only. Your code should
// not get or set this information directly.
Auth *SourceAuth `locationName:"auth" type:"structure"`
@@ -11022,7 +10967,7 @@ type ProjectSource struct {
// If this value is set, it can be either an inline buildspec definition, the
// path to an alternate buildspec file relative to the value of the built-in
// CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The
- // bucket must be in the same AWS Region as the build project. Specify the buildspec
+ // bucket must be in the same Region as the build project. Specify the buildspec
// file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml).
// If this value is not provided or is set to an empty string, the source code
// must contain a buildspec file in its root directory. For more information,
@@ -11043,13 +10988,13 @@ type ProjectSource struct {
// include:
//
// * For source code settings that are specified in the source action of
- // a pipeline in AWS CodePipeline, location should not be specified. If it
- // is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline
- // uses the settings in a pipeline's source action instead of this value.
+ // a pipeline in CodePipeline, location should not be specified. If it is
+ // specified, CodePipeline ignores it. This is because CodePipeline uses
+ // the settings in a pipeline's source action instead of this value.
//
- // * For source code in an AWS CodeCommit repository, the HTTPS clone URL
- // to the repository that contains the source code and the buildspec file
- // (for example, https://git-codecommit..amazonaws.com/v1/repos/).
+ // * For source code in an CodeCommit repository, the HTTPS clone URL to
+ // the repository that contains the source code and the buildspec file (for
+ // example, https://git-codecommit..amazonaws.com/v1/repos/).
//
// * For source code in an Amazon S3 input bucket, one of the following.
// The path to the ZIP file that contains the source code (for example, //.zip).
@@ -11057,26 +11002,29 @@ type ProjectSource struct {
//
// * For source code in a GitHub repository, the HTTPS clone URL to the repository
// that contains the source and the buildspec file. You must connect your
- // AWS account to your GitHub account. Use the AWS CodeBuild console to start
- // creating a build project. When you use the console to connect (or reconnect)
- // with GitHub, on the GitHub Authorize application page, for Organization
- // access, choose Request access next to each repository you want to allow
- // AWS CodeBuild to have access to, and then choose Authorize application.
- // (After you have connected to your GitHub account, you do not need to finish
- // creating the build project. You can leave the AWS CodeBuild console.)
- // To instruct AWS CodeBuild to use this connection, in the source object,
- // set the auth object's type value to OAUTH.
+ // account to your GitHub account. Use the CodeBuild console to start creating
+ // a build project. When you use the console to connect (or reconnect) with
+ // GitHub, on the GitHub Authorize application page, for Organization access,
+ // choose Request access next to each repository you want to allow CodeBuild
+ // to have access to, and then choose Authorize application. (After you have
+ // connected to your GitHub account, you do not need to finish creating the
+ // build project. You can leave the CodeBuild console.) To instruct CodeBuild
+ // to use this connection, in the source object, set the auth object's type
+ // value to OAUTH.
//
// * For source code in a Bitbucket repository, the HTTPS clone URL to the
// repository that contains the source and the buildspec file. You must connect
- // your AWS account to your Bitbucket account. Use the AWS CodeBuild console
- // to start creating a build project. When you use the console to connect
- // (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your
- // account page, choose Grant access. (After you have connected to your Bitbucket
- // account, you do not need to finish creating the build project. You can
- // leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this
+ // your Amazon Web Services account to your Bitbucket account. Use the CodeBuild
+ // console to start creating a build project. When you use the console to
+ // connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access
+ // to your account page, choose Grant access. (After you have connected to
+ // your Bitbucket account, you do not need to finish creating the build project.
+ // You can leave the CodeBuild console.) To instruct CodeBuild to use this
// connection, in the source object, set the auth object's type value to
// OAUTH.
+ //
+ // If you specify CODEPIPELINE for the Type property, don't specify this property.
+ // For all of the other types, you must specify Location.
Location *string `locationName:"location" type:"string"`
// Set to true to report the status of a build's start and finish to your source
@@ -11088,7 +11036,7 @@ type ProjectSource struct {
// with the source provider must have write access to the repo. If the user
// does not have write access, the build status cannot be updated. For more
// information, see Source provider access (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
//
// The status of a build triggered by a webhook is always reported to your source
// provider.
@@ -11103,10 +11051,10 @@ type ProjectSource struct {
//
// * BITBUCKET: The source code is in a Bitbucket repository.
//
- // * CODECOMMIT: The source code is in an AWS CodeCommit repository.
+ // * CODECOMMIT: The source code is in an CodeCommit repository.
//
// * CODEPIPELINE: The source code settings are specified in the source action
- // of a pipeline in AWS CodePipeline.
+ // of a pipeline in CodePipeline.
//
// * GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.
//
@@ -11228,7 +11176,7 @@ type ProjectSourceVersion struct {
// The source version for the corresponding source identifier. If specified,
// must be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -11246,7 +11194,7 @@ type ProjectSourceVersion struct {
// input ZIP file to use.
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
//
// SourceVersion is a required field
SourceVersion *string `locationName:"sourceVersion" type:"string" required:"true"`
@@ -11296,7 +11244,7 @@ type PutResourcePolicyInput struct {
// A JSON-formatted resource policy. For more information, see Sharing a Project
// (https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share)
// and Sharing a Report Group (https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
//
// Policy is a required field
Policy *string `locationName:"policy" min:"1" type:"string" required:"true"`
@@ -11383,22 +11331,22 @@ func (s *PutResourcePolicyOutput) SetResourceArn(v string) *PutResourcePolicyOut
//
// * images cannot be curated or an Amazon ECR image.
//
-// For more information, see Private Registry with AWS Secrets Manager Sample
-// for AWS CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html).
+// For more information, see Private Registry with Secrets Manager Sample for
+// CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html).
type RegistryCredential struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets
+ // The Amazon Resource Name (ARN) or name of credentials created using Secrets
// Manager.
//
// The credential can use the name of the credentials only if they exist in
- // your current AWS Region.
+ // your current Region.
//
// Credential is a required field
Credential *string `locationName:"credential" min:"1" type:"string" required:"true"`
// The service that created the credentials to access a private Docker registry.
- // The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
+ // The valid value, SECRETS_MANAGER, is for Secrets Manager.
//
// CredentialProvider is a required field
CredentialProvider *string `locationName:"credentialProvider" type:"string" required:"true" enum:"CredentialProviderType"`
@@ -11699,8 +11647,8 @@ type ReportGroup struct {
// A list of tag key and value pairs associated with this report group.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // report group tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild report group tags.
Tags []*Tag `locationName:"tags" type:"list"`
// The type of the ReportGroup. This can be one of the following values:
@@ -11892,8 +11840,8 @@ func (s *ResolvedArtifact) SetType(v string) *ResolvedArtifact {
return s
}
-// The specified AWS resource cannot be created, because an AWS resource with
-// the same settings already exists.
+// The specified Amazon Web Services resource cannot be created, because an
+// Amazon Web Services resource with the same settings already exists.
type ResourceAlreadyExistsException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -11949,7 +11897,7 @@ func (s *ResourceAlreadyExistsException) RequestID() string {
return s.RespMetadata.RequestID
}
-// The specified AWS resource cannot be found.
+// The specified Amazon Web Services resource cannot be found.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -12014,8 +11962,8 @@ type RetryBuildBatchInput struct {
// A unique, case sensitive identifier you provide to ensure the idempotency
// of the RetryBuildBatch request. The token is included in the RetryBuildBatch
// request and is valid for five minutes. If you repeat the RetryBuildBatch
- // request with the same token, but change a parameter, AWS CodeBuild returns
- // a parameter mismatch error.
+ // request with the same token, but change a parameter, CodeBuild returns a
+ // parameter mismatch error.
IdempotencyToken *string `locationName:"idempotencyToken" type:"string"`
// Specifies the type of retry to perform.
@@ -12095,8 +12043,8 @@ type RetryBuildInput struct {
// A unique, case sensitive identifier you provide to ensure the idempotency
// of the RetryBuild request. The token is included in the RetryBuild request
// and is valid for five minutes. If you repeat the RetryBuild request with
- // the same token, but change a parameter, AWS CodeBuild returns a parameter
- // mismatch error.
+ // the same token, but change a parameter, CodeBuild returns a parameter mismatch
+ // error.
IdempotencyToken *string `locationName:"idempotencyToken" type:"string"`
}
@@ -12162,38 +12110,6 @@ func (s *RetryBuildOutput) SetBuild(v *Build) *RetryBuildOutput {
type S3LogsConfig struct {
_ struct{} `type:"structure"`
- // Specifies the access for objects that are uploaded to an Amazon S3 bucket
- // that is owned by another account.
- //
- // By default, only the account that uploads the objects to the bucket has access
- // to these objects. This property allows you to give the bucket owner access
- // to these objects.
- //
- // NONE
- //
- // The bucket owner does not have access to the objects. This is the default.
- //
- // READ_ONLY
- //
- // The bucket owner has read only access to the objects. The uploading account
- // retains ownership of the objects.
- //
- // FULL
- //
- // The bucket owner has full access to the objects. Object ownership is determined
- // by the following criteria:
- //
- // * If the bucket is configured with the Bucket owner preferred setting,
- // the bucket owner owns the objects. The uploading account will have object
- // access as specified by the bucket's policy.
- //
- // * Otherwise, the uploading account retains ownership of the objects.
- //
- // For more information about Amazon S3 object ownership, see Controlling ownership
- // of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
- // in the Amazon Simple Storage Service User Guide.
- BucketOwnerAccess *string `locationName:"bucketOwnerAccess" type:"string" enum:"BucketOwnerAccess"`
-
// Set to true if you do not want your S3 build log output encrypted. By default
// S3 build logs are encrypted.
EncryptionDisabled *bool `locationName:"encryptionDisabled" type:"boolean"`
@@ -12236,12 +12152,6 @@ func (s *S3LogsConfig) Validate() error {
return nil
}
-// SetBucketOwnerAccess sets the BucketOwnerAccess field's value.
-func (s *S3LogsConfig) SetBucketOwnerAccess(v string) *S3LogsConfig {
- s.BucketOwnerAccess = &v
- return s
-}
-
// SetEncryptionDisabled sets the EncryptionDisabled field's value.
func (s *S3LogsConfig) SetEncryptionDisabled(v bool) *S3LogsConfig {
s.EncryptionDisabled = &v
@@ -12267,9 +12177,9 @@ type S3ReportExportConfig struct {
// The name of the S3 bucket where the raw data of a report are exported.
Bucket *string `locationName:"bucket" min:"1" type:"string"`
- // The AWS account identifier of the owner of the Amazon S3 bucket. This allows
- // report data to be exported to an Amazon S3 bucket that is owned by an account
- // other than the account running the build.
+ // The Amazon Web Services account identifier of the owner of the Amazon S3
+ // bucket. This allows report data to be exported to an Amazon S3 bucket that
+ // is owned by an account other than the account running the build.
BucketOwner *string `locationName:"bucketOwner" type:"string"`
// A boolean value that specifies if the results of a report are encrypted.
@@ -12280,11 +12190,10 @@ type S3ReportExportConfig struct {
// The type of build output artifact to create. Valid values include:
//
- // * NONE: AWS CodeBuild creates the raw data in the output bucket. This
- // is the default if packaging is not specified.
+ // * NONE: CodeBuild creates the raw data in the output bucket. This is the
+ // default if packaging is not specified.
//
- // * ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output
- // bucket.
+ // * ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
Packaging *string `locationName:"packaging" type:"string" enum:"ReportPackagingType"`
// The path to the exported report's raw data results.
@@ -12353,10 +12262,10 @@ func (s *S3ReportExportConfig) SetPath(v string) *S3ReportExportConfig {
return s
}
-// Information about the authorization settings for AWS CodeBuild to access
-// the source code to be built.
+// Information about the authorization settings for CodeBuild to access the
+// source code to be built.
//
-// This information is for the AWS CodeBuild console's use only. Your code should
+// This information is for the CodeBuild console's use only. Your code should
// not get or set this information directly.
type SourceAuth struct {
_ struct{} `type:"structure"`
@@ -12474,7 +12383,7 @@ type StartBuildBatchInput struct {
// If this value is set, it can be either an inline buildspec definition, the
// path to an alternate buildspec file relative to the value of the built-in
// CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The
- // bucket must be in the same AWS Region as the build project. Specify the buildspec
+ // bucket must be in the same Region as the build project. Specify the buildspec
// file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml).
// If this value is not provided or is set to an empty string, the source code
// must contain a buildspec file in its root directory. For more information,
@@ -12497,9 +12406,9 @@ type StartBuildBatchInput struct {
// Batch session debugging is not supported for matrix batch builds.
DebugSessionEnabled *bool `locationName:"debugSessionEnabled" type:"boolean"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides
- // the one specified in the batch build project. The CMK key encrypts the build
- // output artifacts.
+ // The Key Management Service customer master key (CMK) that overrides the one
+ // specified in the batch build project. The CMK key encrypts the build output
+ // artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -12528,28 +12437,28 @@ type StartBuildBatchInput struct {
// A unique, case sensitive identifier you provide to ensure the idempotency
// of the StartBuildBatch request. The token is included in the StartBuildBatch
// request and is valid for five minutes. If you repeat the StartBuildBatch
- // request with the same token, but change a parameter, AWS CodeBuild returns
- // a parameter mismatch error.
+ // request with the same token, but change a parameter, CodeBuild returns a
+ // parameter mismatch error.
IdempotencyToken *string `locationName:"idempotencyToken" type:"string"`
// The name of an image for this batch build that overrides the one specified
// in the batch build project.
ImageOverride *string `locationName:"imageOverride" min:"1" type:"string"`
- // The type of credentials AWS CodeBuild uses to pull images in your batch build.
+ // The type of credentials CodeBuild uses to pull images in your batch build.
// There are two valid values:
//
// CODEBUILD
//
- // Specifies that AWS CodeBuild uses its own credentials. This requires that
- // you modify your ECR repository policy to trust AWS CodeBuild's service principal.
+ // Specifies that CodeBuild uses its own credentials. This requires that you
+ // modify your ECR repository policy to trust CodeBuild's service principal.
//
// SERVICE_ROLE
//
- // Specifies that AWS CodeBuild uses your build project's service role.
+ // Specifies that CodeBuild uses your build project's service role.
//
// When using a cross-account or private registry image, you must use SERVICE_ROLE
- // credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD
+ // credentials. When using an CodeBuild curated image, you must use CODEBUILD
// credentials.
ImagePullCredentialsTypeOverride *string `locationName:"imagePullCredentialsTypeOverride" type:"string" enum:"ImagePullCredentialsType"`
@@ -12621,7 +12530,7 @@ type StartBuildBatchInput struct {
// not specified, the latest version is used. If specified, the contents depends
// on the source provider:
//
- // AWS CodeCommit
+ // CodeCommit
//
// The commit ID, branch, or Git tag to use.
//
@@ -12649,7 +12558,7 @@ type StartBuildBatchInput struct {
// (at the build level) takes precedence.
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" type:"string"`
}
@@ -12996,7 +12905,7 @@ type StartBuildInput struct {
// If this value is set, it can be either an inline buildspec definition, the
// path to an alternate buildspec file relative to the value of the built-in
// CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The
- // bucket must be in the same AWS Region as the build project. Specify the buildspec
+ // bucket must be in the same Region as the build project. Specify the buildspec
// file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml).
// If this value is not provided or is set to an empty string, the source code
// must contain a buildspec file in its root directory. For more information,
@@ -13019,9 +12928,8 @@ type StartBuildInput struct {
// see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html).
DebugSessionEnabled *bool `locationName:"debugSessionEnabled" type:"boolean"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides
- // the one specified in the build project. The CMK key encrypts the build output
- // artifacts.
+ // The Key Management Service customer master key (CMK) that overrides the one
+ // specified in the build project. The CMK key encrypts the build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -13042,14 +12950,14 @@ type StartBuildInput struct {
// for this build only, any previous depth of history defined in the build project.
GitCloneDepthOverride *int64 `locationName:"gitCloneDepthOverride" type:"integer"`
- // Information about the Git submodules configuration for this build of an AWS
- // CodeBuild build project.
+ // Information about the Git submodules configuration for this build of an CodeBuild
+ // build project.
GitSubmodulesConfigOverride *GitSubmodulesConfig `locationName:"gitSubmodulesConfigOverride" type:"structure"`
// A unique, case sensitive identifier you provide to ensure the idempotency
// of the StartBuild request. The token is included in the StartBuild request
// and is valid for 5 minutes. If you repeat the StartBuild request with the
- // same token, but change a parameter, AWS CodeBuild returns a parameter mismatch
+ // same token, but change a parameter, CodeBuild returns a parameter mismatch
// error.
IdempotencyToken *string `locationName:"idempotencyToken" type:"string"`
@@ -13057,20 +12965,20 @@ type StartBuildInput struct {
// build project.
ImageOverride *string `locationName:"imageOverride" min:"1" type:"string"`
- // The type of credentials AWS CodeBuild uses to pull images in your build.
- // There are two valid values:
+ // The type of credentials CodeBuild uses to pull images in your build. There
+ // are two valid values:
//
// CODEBUILD
//
- // Specifies that AWS CodeBuild uses its own credentials. This requires that
- // you modify your ECR repository policy to trust AWS CodeBuild's service principal.
+ // Specifies that CodeBuild uses its own credentials. This requires that you
+ // modify your ECR repository policy to trust CodeBuild's service principal.
//
// SERVICE_ROLE
//
- // Specifies that AWS CodeBuild uses your build project's service role.
+ // Specifies that CodeBuild uses your build project's service role.
//
// When using a cross-account or private registry image, you must use SERVICE_ROLE
- // credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD
+ // credentials. When using an CodeBuild curated image, you must use CODEBUILD
// credentials.
ImagePullCredentialsTypeOverride *string `locationName:"imagePullCredentialsTypeOverride" type:"string" enum:"ImagePullCredentialsType"`
@@ -13087,7 +12995,7 @@ type StartBuildInput struct {
// Enable this flag to override privileged mode in the build project.
PrivilegedModeOverride *bool `locationName:"privilegedModeOverride" type:"boolean"`
- // The name of the AWS CodeBuild build project to start running a build.
+ // The name of the CodeBuild build project to start running a build.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
@@ -13106,7 +13014,7 @@ type StartBuildInput struct {
// with the source provider must have write access to the repo. If the user
// does not have write access, the build status cannot be updated. For more
// information, see Source provider access (https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
//
// The status of a build triggered by a webhook is always reported to your source
// provider.
@@ -13143,7 +13051,7 @@ type StartBuildInput struct {
// the latest version is used. If specified, the contents depends on the source
// provider:
//
- // AWS CodeCommit
+ // CodeCommit
//
// The commit ID, branch, or Git tag to use.
//
@@ -13171,7 +13079,7 @@ type StartBuildInput struct {
// (at the build level) takes precedence.
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" type:"string"`
// The number of build timeout minutes, from 5 to 480 (8 hours), that overrides,
@@ -13629,7 +13537,8 @@ func (s *StopBuildOutput) SetBuild(v *Build) *StopBuildOutput {
// A tag, consisting of a key and a value.
//
-// This tag is available for use by AWS services that support tags in AWS CodeBuild.
+// This tag is available for use by Amazon Web Services services that support
+// tags in CodeBuild.
type Tag struct {
_ struct{} `type:"structure"`
@@ -13894,8 +13803,8 @@ type UpdateProjectInput struct {
// A new or replacement description of the build project.
Description *string `locationName:"description" type:"string"`
- // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be
- // used for encrypting the build output artifacts.
+ // The Key Management Service customer master key (CMK) to be used for encrypting
+ // the build output artifacts.
//
// You can use a cross-account KMS key to encrypt the build output artifacts
// if your service role has permission to that key.
@@ -13913,7 +13822,7 @@ type UpdateProjectInput struct {
FileSystemLocations []*ProjectFileSystemLocation `locationName:"fileSystemLocations" type:"list"`
// Information about logs for the build project. A project can create logs in
- // Amazon CloudWatch Logs, logs in an S3 bucket, or both.
+ // CloudWatch Logs, logs in an S3 bucket, or both.
LogsConfig *LogsConfig `locationName:"logsConfig" type:"structure"`
// The name of the build project.
@@ -13937,9 +13846,9 @@ type UpdateProjectInput struct {
// An array of ProjectSource objects.
SecondarySources []*ProjectSource `locationName:"secondarySources" type:"list"`
- // The replacement ARN of the AWS Identity and Access Management (IAM) role
- // that enables AWS CodeBuild to interact with dependent AWS services on behalf
- // of the AWS account.
+ // The replacement ARN of the Identity and Access Management role that enables
+ // CodeBuild to interact with dependent Amazon Web Services services on behalf
+ // of the Amazon Web Services account.
ServiceRole *string `locationName:"serviceRole" min:"1" type:"string"`
// Information to be changed about the build input source code for the build
@@ -13949,7 +13858,7 @@ type UpdateProjectInput struct {
// A version of the build input to be built for this project. If not specified,
// the latest version is used. If specified, it must be one of:
//
- // * For AWS CodeCommit: the commit ID, branch, or Git tag to use.
+ // * For CodeCommit: the commit ID, branch, or Git tag to use.
//
// * For GitHub: the commit ID, pull request ID, branch name, or tag name
// that corresponds to the version of the source code you want to build.
@@ -13970,20 +13879,20 @@ type UpdateProjectInput struct {
// precedence over this sourceVersion (at the project level).
//
// For more information, see Source Version Sample with CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html)
- // in the AWS CodeBuild User Guide.
+ // in the CodeBuild User Guide.
SourceVersion *string `locationName:"sourceVersion" type:"string"`
// An updated list of tag key and value pairs associated with this build project.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // build project tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild build project tags.
Tags []*Tag `locationName:"tags" type:"list"`
- // The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild
+ // The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild
// to wait before timing out any related build that did not get marked as completed.
TimeoutInMinutes *int64 `locationName:"timeoutInMinutes" min:"5" type:"integer"`
- // VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
+ // VpcConfig enables CodeBuild to access resources in an Amazon VPC.
VpcConfig *VpcConfig `locationName:"vpcConfig" type:"structure"`
}
@@ -14266,8 +14175,8 @@ type UpdateReportGroupInput struct {
// An updated list of tag key and value pairs associated with this report group.
//
- // These tags are available for use by AWS services that support AWS CodeBuild
- // report group tags.
+ // These tags are available for use by Amazon Web Services services that support
+ // CodeBuild report group tags.
Tags []*Tag `locationName:"tags" type:"list"`
}
@@ -14372,7 +14281,7 @@ type UpdateWebhookInput struct {
// WebhookFilter.
FilterGroups [][]*WebhookFilter `locationName:"filterGroups" type:"list"`
- // The name of the AWS CodeBuild project.
+ // The name of the CodeBuild project.
//
// ProjectName is a required field
ProjectName *string `locationName:"projectName" min:"2" type:"string" required:"true"`
@@ -14443,7 +14352,7 @@ type UpdateWebhookOutput struct {
_ struct{} `type:"structure"`
// Information about a repository's webhook that is associated with a project
- // in AWS CodeBuild.
+ // in CodeBuild.
Webhook *Webhook `locationName:"webhook" type:"structure"`
}
@@ -14463,7 +14372,7 @@ func (s *UpdateWebhookOutput) SetWebhook(v *Webhook) *UpdateWebhookOutput {
return s
}
-// Information about the VPC configuration that AWS CodeBuild accesses.
+// Information about the VPC configuration that CodeBuild accesses.
type VpcConfig struct {
_ struct{} `type:"structure"`
@@ -14519,7 +14428,7 @@ func (s *VpcConfig) SetVpcId(v string) *VpcConfig {
}
// Information about a webhook that connects repository events to a build project
-// in AWS CodeBuild.
+// in CodeBuild.
type Webhook struct {
_ struct{} `type:"structure"`
@@ -14546,7 +14455,7 @@ type Webhook struct {
// modified.
LastModifiedSecret *time.Time `locationName:"lastModifiedSecret" type:"timestamp"`
- // The AWS CodeBuild endpoint where webhook events are sent.
+ // The CodeBuild endpoint where webhook events are sent.
PayloadUrl *string `locationName:"payloadUrl" min:"1" type:"string"`
// The secret token of the associated repository.
@@ -14788,56 +14697,6 @@ func AuthType_Values() []string {
}
}
-// Specifies the access for objects that are uploaded to an Amazon S3 bucket
-// that is owned by another account.
-//
-// By default, only the account that uploads the objects to the bucket has access
-// to these objects. This property allows you to give the bucket owner access
-// to these objects.
-//
-// NONE
-//
-// The bucket owner does not have access to the objects. This is the default.
-//
-// READ_ONLY
-//
-// The bucket owner has read only access to the objects. The uploading account
-// retains ownership of the objects.
-//
-// FULL
-//
-// The bucket owner has full access to the objects. Object ownership is determined
-// by the following criteria:
-//
-// * If the bucket is configured with the Bucket owner preferred setting,
-// the bucket owner owns the objects. The uploading account will have object
-// access as specified by the bucket's policy.
-//
-// * Otherwise, the uploading account retains ownership of the objects.
-//
-// For more information about Amazon S3 object ownership, see Controlling ownership
-// of uploaded objects using S3 Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)
-// in the Amazon Simple Storage Service User Guide.
-const (
- // BucketOwnerAccessNone is a BucketOwnerAccess enum value
- BucketOwnerAccessNone = "NONE"
-
- // BucketOwnerAccessReadOnly is a BucketOwnerAccess enum value
- BucketOwnerAccessReadOnly = "READ_ONLY"
-
- // BucketOwnerAccessFull is a BucketOwnerAccess enum value
- BucketOwnerAccessFull = "FULL"
-)
-
-// BucketOwnerAccess_Values returns all elements of the BucketOwnerAccess enum
-func BucketOwnerAccess_Values() []string {
- return []string{
- BucketOwnerAccessNone,
- BucketOwnerAccessReadOnly,
- BucketOwnerAccessFull,
- }
-}
-
const (
// BuildBatchPhaseTypeSubmitted is a BuildBatchPhaseType enum value
BuildBatchPhaseTypeSubmitted = "SUBMITTED"
diff --git a/service/codebuild/doc.go b/service/codebuild/doc.go
index fe25ba1d2fb..75ec93ed802 100644
--- a/service/codebuild/doc.go
+++ b/service/codebuild/doc.go
@@ -3,16 +3,15 @@
// Package codebuild provides the client and types for making API
// requests to AWS CodeBuild.
//
-// AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild
-// compiles your source code, runs unit tests, and produces artifacts that are
-// ready to deploy. AWS CodeBuild eliminates the need to provision, manage,
-// and scale your own build servers. It provides prepackaged build environments
-// for the most popular programming languages and build tools, such as Apache
-// Maven, Gradle, and more. You can also fully customize build environments
-// in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically
-// to meet peak build requests. You pay only for the build time you consume.
-// For more information about AWS CodeBuild, see the AWS CodeBuild User Guide
-// (https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html).
+// CodeBuild is a fully managed build service in the cloud. CodeBuild compiles
+// your source code, runs unit tests, and produces artifacts that are ready
+// to deploy. CodeBuild eliminates the need to provision, manage, and scale
+// your own build servers. It provides prepackaged build environments for the
+// most popular programming languages and build tools, such as Apache Maven,
+// Gradle, and more. You can also fully customize build environments in CodeBuild
+// to use your own build tools. CodeBuild scales automatically to meet peak
+// build requests. You pay only for the build time you consume. For more information
+// about CodeBuild, see the CodeBuild User Guide (https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html).
//
// See https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06 for more information on this service.
//
diff --git a/service/codebuild/errors.go b/service/codebuild/errors.go
index 1f4a4d3b920..b727d90d5f1 100644
--- a/service/codebuild/errors.go
+++ b/service/codebuild/errors.go
@@ -11,7 +11,8 @@ const (
// ErrCodeAccountLimitExceededException for service response error code
// "AccountLimitExceededException".
//
- // An AWS service limit was exceeded for the calling AWS account.
+ // An Amazon Web Services service limit was exceeded for the calling Amazon
+ // Web Services account.
ErrCodeAccountLimitExceededException = "AccountLimitExceededException"
// ErrCodeInvalidInputException for service response error code
@@ -29,14 +30,14 @@ const (
// ErrCodeResourceAlreadyExistsException for service response error code
// "ResourceAlreadyExistsException".
//
- // The specified AWS resource cannot be created, because an AWS resource with
- // the same settings already exists.
+ // The specified Amazon Web Services resource cannot be created, because an
+ // Amazon Web Services resource with the same settings already exists.
ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"
// ErrCodeResourceNotFoundException for service response error code
// "ResourceNotFoundException".
//
- // The specified AWS resource cannot be found.
+ // The specified Amazon Web Services resource cannot be found.
ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
diff --git a/service/connect/api.go b/service/connect/api.go
index 6c4f54b04e6..d03399bbaf5 100644
--- a/service/connect/api.go
+++ b/service/connect/api.go
@@ -1246,8 +1246,6 @@ func (c *Connect) CreateQuickConnectRequest(input *CreateQuickConnectInput) (req
// CreateQuickConnect API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Creates a quick connect for the specified Amazon Connect instance.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -1916,8 +1914,6 @@ func (c *Connect) DeleteQuickConnectRequest(input *DeleteQuickConnectInput) (req
// DeleteQuickConnect API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Deletes a quick connect.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -2852,8 +2848,6 @@ func (c *Connect) DescribeQuickConnectRequest(input *DescribeQuickConnectInput)
// DescribeQuickConnect API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Describes the quick connect.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -6678,8 +6672,6 @@ func (c *Connect) ListQuickConnectsRequest(input *ListQuickConnectsInput) (req *
// ListQuickConnects API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Provides information about the quick connects for the specified Amazon Connect
// instance.
//
@@ -9923,8 +9915,6 @@ func (c *Connect) UpdateQuickConnectConfigRequest(input *UpdateQuickConnectConfi
// UpdateQuickConnectConfig API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Updates the configuration settings for the specified quick connect.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -10017,8 +10007,6 @@ func (c *Connect) UpdateQuickConnectNameRequest(input *UpdateQuickConnectNameInp
// UpdateQuickConnectName API operation for Amazon Connect Service.
//
-// This API is in preview release for Amazon Connect and is subject to change.
-//
// Updates the name and description of a quick connect. The request accepts
// the following data in JSON format. At least Name or Description must be provided.
//
@@ -12706,7 +12694,7 @@ type CreateQuickConnectInput struct {
_ struct{} `type:"structure"`
// The description of the quick connect.
- Description *string `type:"string"`
+ Description *string `min:"1" type:"string"`
// The identifier of the Amazon Connect instance. You can find the instanceId
// in the ARN of the instance.
@@ -12741,6 +12729,9 @@ func (s CreateQuickConnectInput) GoString() string {
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreateQuickConnectInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "CreateQuickConnectInput"}
+ if s.Description != nil && len(*s.Description) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("Description", 1))
+ }
if s.InstanceId == nil {
invalidParams.Add(request.NewErrParamRequired("InstanceId"))
}
@@ -20547,7 +20538,7 @@ type MediaConcurrency struct {
//
// Valid Range for VOICE: Minimum value of 1. Maximum value of 1.
//
- // Valid Range for CHAT: Minimum value of 1. Maximum value of 5.
+ // Valid Range for CHAT: Minimum value of 1. Maximum value of 10.
//
// Valid Range for TASK: Minimum value of 1. Maximum value of 10.
//
@@ -21155,7 +21146,7 @@ type QuickConnect struct {
_ struct{} `type:"structure"`
// The description.
- Description *string `type:"string"`
+ Description *string `min:"1" type:"string"`
// The name of the quick connect.
Name *string `min:"1" type:"string"`
diff --git a/service/dax/api.go b/service/dax/api.go
index 1d3195713aa..e3921f1f331 100644
--- a/service/dax/api.go
+++ b/service/dax/api.go
@@ -111,6 +111,11 @@ func (c *DAX) CreateClusterRequest(input *CreateClusterInput) (req *request.Requ
// * InvalidParameterCombinationException
// Two or more incompatible parameters were specified.
//
+// * ServiceQuotaExceededException
+// You have reached the maximum number of x509 certificates that can be created
+// for encrypted clusters in a 30 day period. Contact AWS customer support to
+// discuss options for continuing to create encrypted clusters.
+//
// See also, https://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateCluster
func (c *DAX) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error) {
req, out := c.CreateClusterRequest(input)
@@ -2017,12 +2022,16 @@ type Cluster struct {
// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterArn *string `type:"string"`
- // The configuration endpoint for this DAX cluster, consisting of a DNS name
- // and a port number. Client applications can specify this endpoint, rather
- // than an individual node endpoint, and allow the DAX client software to intelligently
- // route requests and responses to nodes in the DAX cluster.
+ // The endpoint for this DAX cluster, consisting of a DNS name, a port number,
+ // and a URL. Applications should use the URL to configure the DAX client to
+ // find their cluster.
ClusterDiscoveryEndpoint *Endpoint `type:"structure"`
+ // The type of encryption supported by the cluster's endpoint. Values are:
+ //
+ // * NONE for no encryption TLS for Transport Layer Security
+ ClusterEndpointEncryptionType *string `type:"string" enum:"ClusterEndpointEncryptionType"`
+
// The name of the DAX cluster.
ClusterName *string `type:"string"`
@@ -2102,6 +2111,12 @@ func (s *Cluster) SetClusterDiscoveryEndpoint(v *Endpoint) *Cluster {
return s
}
+// SetClusterEndpointEncryptionType sets the ClusterEndpointEncryptionType field's value.
+func (s *Cluster) SetClusterEndpointEncryptionType(v string) *Cluster {
+ s.ClusterEndpointEncryptionType = &v
+ return s
+}
+
// SetClusterName sets the ClusterName field's value.
func (s *Cluster) SetClusterName(v string) *Cluster {
s.ClusterName = &v
@@ -2364,6 +2379,13 @@ type CreateClusterInput struct {
// DAX will spread the nodes across Availability Zones for the highest availability.
AvailabilityZones []*string `type:"list"`
+ // The type of encryption the cluster's endpoint should support. Values are:
+ //
+ // * NONE for no encryption
+ //
+ // * TLS for Transport Layer Security
+ ClusterEndpointEncryptionType *string `type:"string" enum:"ClusterEndpointEncryptionType"`
+
// The cluster identifier. This parameter is stored as a lowercase string.
//
// Constraints:
@@ -2502,6 +2524,12 @@ func (s *CreateClusterInput) SetAvailabilityZones(v []*string) *CreateClusterInp
return s
}
+// SetClusterEndpointEncryptionType sets the ClusterEndpointEncryptionType field's value.
+func (s *CreateClusterInput) SetClusterEndpointEncryptionType(v string) *CreateClusterInput {
+ s.ClusterEndpointEncryptionType = &v
+ return s
+}
+
// SetClusterName sets the ClusterName field's value.
func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput {
s.ClusterName = &v
@@ -3566,8 +3594,7 @@ func (s *DescribeSubnetGroupsOutput) SetSubnetGroups(v []*SubnetGroup) *Describe
}
// Represents the information required for client programs to connect to the
-// configuration endpoint for a DAX cluster, or to an individual node within
-// the cluster.
+// endpoint for a DAX cluster.
type Endpoint struct {
_ struct{} `type:"structure"`
@@ -3576,6 +3603,10 @@ type Endpoint struct {
// The port number that applications should use to connect to the endpoint.
Port *int64 `type:"integer"`
+
+ // The URL that applications should use to connect to the endpoint. The default
+ // ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.
+ URL *string `type:"string"`
}
// String returns the string representation
@@ -3600,6 +3631,12 @@ func (s *Endpoint) SetPort(v int64) *Endpoint {
return s
}
+// SetURL sets the URL field's value.
+func (s *Endpoint) SetURL(v string) *Endpoint {
+ s.URL = &v
+ return s
+}
+
// Represents a single occurrence of something interesting within the system.
// Some examples of events are creating a DAX cluster, adding or removing a
// node, or rebooting a node.
@@ -4555,7 +4592,9 @@ type NotificationConfiguration struct {
// The Amazon Resource Name (ARN) that identifies the topic.
TopicArn *string `type:"string"`
- // The current state of the topic.
+ // The current state of the topic. A value of “active” means that notifications
+ // will be sent to the topic. A value of “inactive” means that notifications
+ // will not be sent to the topic.
TopicStatus *string `type:"string"`
}
@@ -5203,6 +5242,64 @@ func (s *ServiceLinkedRoleNotFoundFault) RequestID() string {
return s.RespMetadata.RequestID
}
+// You have reached the maximum number of x509 certificates that can be created
+// for encrypted clusters in a 30 day period. Contact AWS customer support to
+// discuss options for continuing to create encrypted clusters.
+type ServiceQuotaExceededException struct {
+ _ struct{} `type:"structure"`
+ RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
+
+ Message_ *string `locationName:"message" type:"string"`
+}
+
+// String returns the string representation
+func (s ServiceQuotaExceededException) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ServiceQuotaExceededException) GoString() string {
+ return s.String()
+}
+
+func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error {
+ return &ServiceQuotaExceededException{
+ RespMetadata: v,
+ }
+}
+
+// Code returns the exception type name.
+func (s *ServiceQuotaExceededException) Code() string {
+ return "ServiceQuotaExceededException"
+}
+
+// Message returns the exception's message.
+func (s *ServiceQuotaExceededException) Message() string {
+ if s.Message_ != nil {
+ return *s.Message_
+ }
+ return ""
+}
+
+// OrigErr always returns nil, satisfies awserr.Error interface.
+func (s *ServiceQuotaExceededException) OrigErr() error {
+ return nil
+}
+
+func (s *ServiceQuotaExceededException) Error() string {
+ return fmt.Sprintf("%s: %s", s.Code(), s.Message())
+}
+
+// Status code returns the HTTP status code for the request's response error.
+func (s *ServiceQuotaExceededException) StatusCode() int {
+ return s.RespMetadata.StatusCode
+}
+
+// RequestID returns the service's response RequestID for request.
+func (s *ServiceQuotaExceededException) RequestID() string {
+ return s.RespMetadata.RequestID
+}
+
// Represents the subnet associated with a DAX cluster. This parameter refers
// to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used
// with DAX.
@@ -5950,7 +6047,9 @@ type UpdateClusterInput struct {
// The Amazon Resource Name (ARN) that identifies the topic.
NotificationTopicArn *string `type:"string"`
- // The current state of the topic.
+ // The current state of the topic. A value of “active” means that notifications
+ // will be sent to the topic. A value of “inactive” means that notifications
+ // will not be sent to the topic.
NotificationTopicStatus *string `type:"string"`
// The name of a parameter group for this cluster.
@@ -6066,6 +6165,9 @@ type UpdateParameterGroupInput struct {
// An array of name-value pairs for the parameters in the group. Each element
// in the array represents a single parameter.
//
+ // record-ttl-millis and query-ttl-millis are the only supported parameter names.
+ // For more details, see Configuring TTL Settings (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl).
+ //
// ParameterNameValues is a required field
ParameterNameValues []*ParameterNameValue `type:"list" required:"true"`
}
@@ -6226,6 +6328,22 @@ func ChangeType_Values() []string {
}
}
+const (
+ // ClusterEndpointEncryptionTypeNone is a ClusterEndpointEncryptionType enum value
+ ClusterEndpointEncryptionTypeNone = "NONE"
+
+ // ClusterEndpointEncryptionTypeTls is a ClusterEndpointEncryptionType enum value
+ ClusterEndpointEncryptionTypeTls = "TLS"
+)
+
+// ClusterEndpointEncryptionType_Values returns all elements of the ClusterEndpointEncryptionType enum
+func ClusterEndpointEncryptionType_Values() []string {
+ return []string{
+ ClusterEndpointEncryptionTypeNone,
+ ClusterEndpointEncryptionTypeTls,
+ }
+}
+
const (
// IsModifiableTrue is a IsModifiable enum value
IsModifiableTrue = "TRUE"
diff --git a/service/dax/errors.go b/service/dax/errors.go
index c42b6b81713..044be4f2567 100644
--- a/service/dax/errors.go
+++ b/service/dax/errors.go
@@ -118,6 +118,14 @@ const (
// The specified service linked role (SLR) was not found.
ErrCodeServiceLinkedRoleNotFoundFault = "ServiceLinkedRoleNotFoundFault"
+ // ErrCodeServiceQuotaExceededException for service response error code
+ // "ServiceQuotaExceededException".
+ //
+ // You have reached the maximum number of x509 certificates that can be created
+ // for encrypted clusters in a 30 day period. Contact AWS customer support to
+ // discuss options for continuing to create encrypted clusters.
+ ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"
+
// ErrCodeSubnetGroupAlreadyExistsFault for service response error code
// "SubnetGroupAlreadyExistsFault".
//
@@ -188,6 +196,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{
"ParameterGroupNotFoundFault": newErrorParameterGroupNotFoundFault,
"ParameterGroupQuotaExceededFault": newErrorParameterGroupQuotaExceededFault,
"ServiceLinkedRoleNotFoundFault": newErrorServiceLinkedRoleNotFoundFault,
+ "ServiceQuotaExceededException": newErrorServiceQuotaExceededException,
"SubnetGroupAlreadyExistsFault": newErrorSubnetGroupAlreadyExistsFault,
"SubnetGroupInUseFault": newErrorSubnetGroupInUseFault,
"SubnetGroupNotFoundFault": newErrorSubnetGroupNotFoundFault,
diff --git a/service/kendra/api.go b/service/kendra/api.go
index b56cf40a4fb..fe92b2dbb91 100644
--- a/service/kendra/api.go
+++ b/service/kendra/api.go
@@ -13786,8 +13786,9 @@ type SharePointConfiguration struct {
InclusionPatterns []*string `type:"list"`
// The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager.
- // The credentials should be a user/password pair. For more information, see
- // Using a Microsoft SharePoint Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html).
+ // The credentials should be a user/password pair. If you use SharePoint Sever,
+ // you also need to provide the sever domain name as part of the credentials.
+ // For more information, see Using a Microsoft SharePoint Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html).
// For more information about AWS Secrets Manager, see What Is AWS Secrets Manager
// (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
// in the AWS Secrets Manager user guide.
@@ -13800,6 +13801,9 @@ type SharePointConfiguration struct {
// SharePointVersion is a required field
SharePointVersion *string `type:"string" required:"true" enum:"SharePointVersion"`
+ // Information required to find a specific file in an Amazon S3 bucket.
+ SslCertificateS3Path *S3Path `type:"structure"`
+
// The URLs of the Microsoft SharePoint site that contains the documents that
// should be indexed.
//
@@ -13861,6 +13865,11 @@ func (s *SharePointConfiguration) Validate() error {
}
}
}
+ if s.SslCertificateS3Path != nil {
+ if err := s.SslCertificateS3Path.Validate(); err != nil {
+ invalidParams.AddNested("SslCertificateS3Path", err.(request.ErrInvalidParams))
+ }
+ }
if s.VpcConfiguration != nil {
if err := s.VpcConfiguration.Validate(); err != nil {
invalidParams.AddNested("VpcConfiguration", err.(request.ErrInvalidParams))
@@ -13921,6 +13930,12 @@ func (s *SharePointConfiguration) SetSharePointVersion(v string) *SharePointConf
return s
}
+// SetSslCertificateS3Path sets the SslCertificateS3Path field's value.
+func (s *SharePointConfiguration) SetSslCertificateS3Path(v *S3Path) *SharePointConfiguration {
+ s.SslCertificateS3Path = v
+ return s
+}
+
// SetUrls sets the Urls field's value.
func (s *SharePointConfiguration) SetUrls(v []*string) *SharePointConfiguration {
s.Urls = v
@@ -16970,6 +16985,12 @@ func ServiceNowBuildVersionType_Values() []string {
}
const (
+ // SharePointVersionSharepoint2013 is a SharePointVersion enum value
+ SharePointVersionSharepoint2013 = "SHAREPOINT_2013"
+
+ // SharePointVersionSharepoint2016 is a SharePointVersion enum value
+ SharePointVersionSharepoint2016 = "SHAREPOINT_2016"
+
// SharePointVersionSharepointOnline is a SharePointVersion enum value
SharePointVersionSharepointOnline = "SHAREPOINT_ONLINE"
)
@@ -16977,6 +16998,8 @@ const (
// SharePointVersion_Values returns all elements of the SharePointVersion enum
func SharePointVersion_Values() []string {
return []string{
+ SharePointVersionSharepoint2013,
+ SharePointVersionSharepoint2016,
SharePointVersionSharepointOnline,
}
}
diff --git a/service/securityhub/api.go b/service/securityhub/api.go
index 4a11b45d168..d70ba91b687 100644
--- a/service/securityhub/api.go
+++ b/service/securityhub/api.go
@@ -7212,6 +7212,10 @@ type AwsApiGatewayV2StageDetails struct {
// Indicates whether updates to an API automatically trigger a new deployment.
AutoDeploy *bool `type:"boolean"`
+ // The identifier of a client certificate for a stage. Supported only for WebSocket
+ // API calls.
+ ClientCertificateId *string `type:"string"`
+
// Indicates when the stage was created.
//
// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
@@ -7287,6 +7291,12 @@ func (s *AwsApiGatewayV2StageDetails) SetAutoDeploy(v bool) *AwsApiGatewayV2Stag
return s
}
+// SetClientCertificateId sets the ClientCertificateId field's value.
+func (s *AwsApiGatewayV2StageDetails) SetClientCertificateId(v string) *AwsApiGatewayV2StageDetails {
+ s.ClientCertificateId = &v
+ return s
+}
+
// SetCreatedDate sets the CreatedDate field's value.
func (s *AwsApiGatewayV2StageDetails) SetCreatedDate(v string) *AwsApiGatewayV2StageDetails {
s.CreatedDate = &v
@@ -8594,8 +8604,8 @@ type AwsCodeBuildProjectDetails struct {
// The AWS Key Management Service (AWS KMS) customer master key (CMK) used to
// encrypt the build output artifacts.
//
- // You can specify either the Amazon Resource Name (ARN) of the CMK or, if available,
- // the CMK alias (using the format alias/alias-name).
+ // You can specify either the ARN of the CMK or, if available, the CMK alias
+ // (using the format alias/alias-name).
EncryptionKey *string `type:"string"`
// Information about the build environment for this build project.
@@ -8748,8 +8758,7 @@ func (s *AwsCodeBuildProjectEnvironment) SetType(v string) *AwsCodeBuildProjectE
type AwsCodeBuildProjectEnvironmentRegistryCredential struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets
- // Manager.
+ // The ARN or name of credentials created using AWS Secrets Manager.
//
// The credential can use the name of the credentials only if they exist in
// your current AWS Region.
@@ -9918,7 +9927,7 @@ func (s *AwsEc2EipDetails) SetPublicIpv4Pool(v string) *AwsEc2EipDetails {
return s
}
-// The details of an Amazon EC2 instance.
+// The details of an EC2 instance.
type AwsEc2InstanceDetails struct {
_ struct{} `type:"structure"`
@@ -9944,6 +9953,11 @@ type AwsEc2InstanceDetails struct {
// contain spaces. For example, 2020-03-22T13:22:13.933Z.
LaunchedAt *string `type:"string"`
+ // The identifiers of the network interfaces for the EC2 instance. The details
+ // for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails
+ // object.
+ NetworkInterfaces []*AwsEc2InstanceNetworkInterfacesDetails `type:"list"`
+
// The identifier of the subnet that the instance was launched in.
SubnetId *string `type:"string"`
@@ -10000,6 +10014,12 @@ func (s *AwsEc2InstanceDetails) SetLaunchedAt(v string) *AwsEc2InstanceDetails {
return s
}
+// SetNetworkInterfaces sets the NetworkInterfaces field's value.
+func (s *AwsEc2InstanceDetails) SetNetworkInterfaces(v []*AwsEc2InstanceNetworkInterfacesDetails) *AwsEc2InstanceDetails {
+ s.NetworkInterfaces = v
+ return s
+}
+
// SetSubnetId sets the SubnetId field's value.
func (s *AwsEc2InstanceDetails) SetSubnetId(v string) *AwsEc2InstanceDetails {
s.SubnetId = &v
@@ -10018,6 +10038,31 @@ func (s *AwsEc2InstanceDetails) SetVpcId(v string) *AwsEc2InstanceDetails {
return s
}
+// Identifies a network interface for the EC2 instance.
+type AwsEc2InstanceNetworkInterfacesDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The identifier of the network interface. The details are in a corresponding
+ // AwsEc2NetworkInterfacesDetails object.
+ NetworkInterfaceId *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsEc2InstanceNetworkInterfacesDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsEc2InstanceNetworkInterfacesDetails) GoString() string {
+ return s.String()
+}
+
+// SetNetworkInterfaceId sets the NetworkInterfaceId field's value.
+func (s *AwsEc2InstanceNetworkInterfacesDetails) SetNetworkInterfaceId(v string) *AwsEc2InstanceNetworkInterfacesDetails {
+ s.NetworkInterfaceId = &v
+ return s
+}
+
// An association between the network ACL and a subnet.
type AwsEc2NetworkAclAssociation struct {
_ struct{} `type:"structure"`
@@ -10747,7 +10792,7 @@ type AwsEc2SecurityGroupUserIdGroupPair struct {
// is deleted, this value is not returned.
//
// [EC2-Classic] Required when adding or removing rules that reference a security
- // group in another AWS.
+ // group in another VPC.
UserId *string `type:"string"`
// The ID of the VPC for the referenced security group, if applicable.
@@ -11124,6427 +11169,9029 @@ func (s *AwsEc2VpcDetails) SetState(v string) *AwsEc2VpcDetails {
return s
}
-// Contains details about an Elastic Beanstalk environment.
-type AwsElasticBeanstalkEnvironmentDetails struct {
+// Indicates whether to enable CloudWatch Container Insights for the ECS cluster.
+type AwsEcsClusterClusterSettingsDetails struct {
_ struct{} `type:"structure"`
- // The name of the application that is associated with the environment.
- ApplicationName *string `type:"string"`
-
- // The URL to the CNAME for this environment.
- Cname *string `type:"string"`
+ // The name of the setting.
+ Name *string `type:"string"`
- // The creation date for this environment.
- DateCreated *string `type:"string"`
+ // The value of the setting.
+ Value *string `type:"string"`
+}
- // The date when this environment was last modified.
- DateUpdated *string `type:"string"`
+// String returns the string representation
+func (s AwsEcsClusterClusterSettingsDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // A description of the environment.
- Description *string `type:"string"`
+// GoString returns the string representation
+func (s AwsEcsClusterClusterSettingsDetails) GoString() string {
+ return s.String()
+}
- // For load-balanced, autoscaling environments, the URL to the load balancer.
- // For single-instance environments, the IP address of the instance.
- EndpointUrl *string `type:"string"`
+// SetName sets the Name field's value.
+func (s *AwsEcsClusterClusterSettingsDetails) SetName(v string) *AwsEcsClusterClusterSettingsDetails {
+ s.Name = &v
+ return s
+}
- // The ARN of the environment.
- EnvironmentArn *string `type:"string"`
+// SetValue sets the Value field's value.
+func (s *AwsEcsClusterClusterSettingsDetails) SetValue(v string) *AwsEcsClusterClusterSettingsDetails {
+ s.Value = &v
+ return s
+}
- // The identifier of the environment.
- EnvironmentId *string `type:"string"`
+// The run command configuration for the cluster.
+type AwsEcsClusterConfigurationDetails struct {
+ _ struct{} `type:"structure"`
- // Links to other environments in the same group.
- EnvironmentLinks []*AwsElasticBeanstalkEnvironmentEnvironmentLink `type:"list"`
+ // Contains the run command configuration for the cluster.
+ ExecuteCommandConfiguration *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails `type:"structure"`
+}
- // The name of the environment.
- EnvironmentName *string `type:"string"`
+// String returns the string representation
+func (s AwsEcsClusterConfigurationDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // The configuration setting for the environment.
- OptionSettings []*AwsElasticBeanstalkEnvironmentOptionSetting `type:"list"`
+// GoString returns the string representation
+func (s AwsEcsClusterConfigurationDetails) GoString() string {
+ return s.String()
+}
- // The ARN of the platform version for the environment.
- PlatformArn *string `type:"string"`
+// SetExecuteCommandConfiguration sets the ExecuteCommandConfiguration field's value.
+func (s *AwsEcsClusterConfigurationDetails) SetExecuteCommandConfiguration(v *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) *AwsEcsClusterConfigurationDetails {
+ s.ExecuteCommandConfiguration = v
+ return s
+}
- // The name of the solution stack that is deployed with the environment.
- SolutionStackName *string `type:"string"`
+// Contains the run command configuration for the cluster.
+type AwsEcsClusterConfigurationExecuteCommandConfigurationDetails struct {
+ _ struct{} `type:"structure"`
- // The current operational status of the environment.
- Status *string `type:"string"`
+ // The identifier of the KMS key that is used to encrypt the data between the
+ // local client and the container.
+ KmsKeyId *string `type:"string"`
- // The tier of the environment.
- Tier *AwsElasticBeanstalkEnvironmentTier `type:"structure"`
+ // The log configuration for the results of the run command actions. Required
+ // if Logging is NONE.
+ LogConfiguration *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails `type:"structure"`
- // The application version of the environment.
- VersionLabel *string `type:"string"`
+ // The log setting to use for redirecting logs for run command results.
+ Logging *string `type:"string"`
}
// String returns the string representation
-func (s AwsElasticBeanstalkEnvironmentDetails) String() string {
+func (s AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElasticBeanstalkEnvironmentDetails) GoString() string {
+func (s AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) GoString() string {
return s.String()
}
-// SetApplicationName sets the ApplicationName field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetApplicationName(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.ApplicationName = &v
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetKmsKeyId(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails {
+ s.KmsKeyId = &v
return s
}
-// SetCname sets the Cname field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetCname(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.Cname = &v
+// SetLogConfiguration sets the LogConfiguration field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogConfiguration(v *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails {
+ s.LogConfiguration = v
return s
}
-// SetDateCreated sets the DateCreated field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateCreated(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.DateCreated = &v
+// SetLogging sets the Logging field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails) SetLogging(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationDetails {
+ s.Logging = &v
return s
}
-// SetDateUpdated sets the DateUpdated field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateUpdated(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.DateUpdated = &v
- return s
-}
+// The log configuration for the results of the run command actions.
+type AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails struct {
+ _ struct{} `type:"structure"`
-// SetDescription sets the Description field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetDescription(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.Description = &v
- return s
-}
+ // Whether to enable encryption on the CloudWatch logs.
+ CloudWatchEncryptionEnabled *bool `type:"boolean"`
-// SetEndpointUrl sets the EndpointUrl field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetEndpointUrl(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.EndpointUrl = &v
- return s
-}
+ // The name of the CloudWatch log group to send the logs to.
+ CloudWatchLogGroupName *string `type:"string"`
-// SetEnvironmentArn sets the EnvironmentArn field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentArn(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.EnvironmentArn = &v
- return s
-}
+ // The name of the S3 bucket to send logs to.
+ S3BucketName *string `type:"string"`
-// SetEnvironmentId sets the EnvironmentId field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentId(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.EnvironmentId = &v
- return s
-}
+ // Whether to encrypt the logs that are sent to the S3 bucket.
+ S3EncryptionEnabled *bool `type:"boolean"`
-// SetEnvironmentLinks sets the EnvironmentLinks field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentLinks(v []*AwsElasticBeanstalkEnvironmentEnvironmentLink) *AwsElasticBeanstalkEnvironmentDetails {
- s.EnvironmentLinks = v
- return s
+ // Identifies the folder in the S3 bucket to send the logs to.
+ S3KeyPrefix *string `type:"string"`
}
-// SetEnvironmentName sets the EnvironmentName field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.EnvironmentName = &v
- return s
+// String returns the string representation
+func (s AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetOptionSettings sets the OptionSettings field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetOptionSettings(v []*AwsElasticBeanstalkEnvironmentOptionSetting) *AwsElasticBeanstalkEnvironmentDetails {
- s.OptionSettings = v
- return s
+// GoString returns the string representation
+func (s AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) GoString() string {
+ return s.String()
}
-// SetPlatformArn sets the PlatformArn field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetPlatformArn(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.PlatformArn = &v
+// SetCloudWatchEncryptionEnabled sets the CloudWatchEncryptionEnabled field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchEncryptionEnabled(v bool) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
+ s.CloudWatchEncryptionEnabled = &v
return s
}
-// SetSolutionStackName sets the SolutionStackName field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetSolutionStackName(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.SolutionStackName = &v
+// SetCloudWatchLogGroupName sets the CloudWatchLogGroupName field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetCloudWatchLogGroupName(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
+ s.CloudWatchLogGroupName = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetStatus(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.Status = &v
+// SetS3BucketName sets the S3BucketName field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3BucketName(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
+ s.S3BucketName = &v
return s
}
-// SetTier sets the Tier field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetTier(v *AwsElasticBeanstalkEnvironmentTier) *AwsElasticBeanstalkEnvironmentDetails {
- s.Tier = v
+// SetS3EncryptionEnabled sets the S3EncryptionEnabled field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3EncryptionEnabled(v bool) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
+ s.S3EncryptionEnabled = &v
return s
}
-// SetVersionLabel sets the VersionLabel field's value.
-func (s *AwsElasticBeanstalkEnvironmentDetails) SetVersionLabel(v string) *AwsElasticBeanstalkEnvironmentDetails {
- s.VersionLabel = &v
+// SetS3KeyPrefix sets the S3KeyPrefix field's value.
+func (s *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails) SetS3KeyPrefix(v string) *AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
+ s.S3KeyPrefix = &v
return s
}
-// Contains information about a link to another environment that is in the same
-// group.
-type AwsElasticBeanstalkEnvironmentEnvironmentLink struct {
+// The default capacity provider strategy for the cluster. The default capacity
+// provider strategy is used when services or tasks are run without a specified
+// launch type or capacity provider strategy.
+type AwsEcsClusterDefaultCapacityProviderStrategyDetails struct {
_ struct{} `type:"structure"`
- // The name of the linked environment.
- EnvironmentName *string `type:"string"`
+ // The minimum number of tasks to run on the specified capacity provider.
+ Base *int64 `type:"integer"`
- // The name of the environment link.
- LinkName *string `type:"string"`
+ // The name of the capacity provider.
+ CapacityProvider *string `type:"string"`
+
+ // The relative percentage of the total number of tasks launched that should
+ // use the capacity provider.
+ Weight *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) String() string {
+func (s AwsEcsClusterDefaultCapacityProviderStrategyDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) GoString() string {
+func (s AwsEcsClusterDefaultCapacityProviderStrategyDetails) GoString() string {
return s.String()
}
-// SetEnvironmentName sets the EnvironmentName field's value.
-func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink {
- s.EnvironmentName = &v
+// SetBase sets the Base field's value.
+func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetBase(v int64) *AwsEcsClusterDefaultCapacityProviderStrategyDetails {
+ s.Base = &v
return s
}
-// SetLinkName sets the LinkName field's value.
-func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetLinkName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink {
- s.LinkName = &v
+// SetCapacityProvider sets the CapacityProvider field's value.
+func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetCapacityProvider(v string) *AwsEcsClusterDefaultCapacityProviderStrategyDetails {
+ s.CapacityProvider = &v
return s
}
-// A configuration option setting for the environment.
-type AwsElasticBeanstalkEnvironmentOptionSetting struct {
+// SetWeight sets the Weight field's value.
+func (s *AwsEcsClusterDefaultCapacityProviderStrategyDetails) SetWeight(v int64) *AwsEcsClusterDefaultCapacityProviderStrategyDetails {
+ s.Weight = &v
+ return s
+}
+
+// provides details about an ECS cluster.
+type AwsEcsClusterDetails struct {
_ struct{} `type:"structure"`
- // The type of resource that the configuration option is associated with.
- Namespace *string `type:"string"`
+ // The short name of one or more capacity providers to associate with the cluster.
+ CapacityProviders []*string `type:"list"`
- // The name of the option.
- OptionName *string `type:"string"`
+ // The setting to use to create the cluster. Specifically used to configure
+ // whether to enable CloudWatch Container Insights for the cluster.
+ ClusterSettings []*AwsEcsClusterClusterSettingsDetails `type:"list"`
- // The name of the resource.
- ResourceName *string `type:"string"`
+ // The run command configuration for the cluster.
+ Configuration *AwsEcsClusterConfigurationDetails `type:"structure"`
- // The value of the configuration setting.
- Value *string `type:"string"`
+ // The default capacity provider strategy for the cluster. The default capacity
+ // provider strategy is used when services or tasks are run without a specified
+ // launch type or capacity provider strategy.
+ DefaultCapacityProviderStrategy []*AwsEcsClusterDefaultCapacityProviderStrategyDetails `type:"list"`
}
// String returns the string representation
-func (s AwsElasticBeanstalkEnvironmentOptionSetting) String() string {
+func (s AwsEcsClusterDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElasticBeanstalkEnvironmentOptionSetting) GoString() string {
+func (s AwsEcsClusterDetails) GoString() string {
return s.String()
}
-// SetNamespace sets the Namespace field's value.
-func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetNamespace(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
- s.Namespace = &v
+// SetCapacityProviders sets the CapacityProviders field's value.
+func (s *AwsEcsClusterDetails) SetCapacityProviders(v []*string) *AwsEcsClusterDetails {
+ s.CapacityProviders = v
return s
}
-// SetOptionName sets the OptionName field's value.
-func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetOptionName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
- s.OptionName = &v
+// SetClusterSettings sets the ClusterSettings field's value.
+func (s *AwsEcsClusterDetails) SetClusterSettings(v []*AwsEcsClusterClusterSettingsDetails) *AwsEcsClusterDetails {
+ s.ClusterSettings = v
return s
}
-// SetResourceName sets the ResourceName field's value.
-func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetResourceName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
- s.ResourceName = &v
+// SetConfiguration sets the Configuration field's value.
+func (s *AwsEcsClusterDetails) SetConfiguration(v *AwsEcsClusterConfigurationDetails) *AwsEcsClusterDetails {
+ s.Configuration = v
return s
}
-// SetValue sets the Value field's value.
-func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetValue(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
- s.Value = &v
+// SetDefaultCapacityProviderStrategy sets the DefaultCapacityProviderStrategy field's value.
+func (s *AwsEcsClusterDetails) SetDefaultCapacityProviderStrategy(v []*AwsEcsClusterDefaultCapacityProviderStrategyDetails) *AwsEcsClusterDetails {
+ s.DefaultCapacityProviderStrategy = v
return s
}
-// Contains information about the tier of the environment.
-type AwsElasticBeanstalkEnvironmentTier struct {
+// A dependency that is defined for container startup and shutdown.
+type AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails struct {
_ struct{} `type:"structure"`
- // The name of the environment tier.
- Name *string `type:"string"`
-
- // The type of environment tier.
- Type *string `type:"string"`
+ // The dependency condition of the dependent container. Indicates the required
+ // status of the dependent container before the current container can start.
+ Condition *string `type:"string"`
- // The version of the environment tier.
- Version *string `type:"string"`
+ // The name of the dependent container.
+ ContainerName *string `type:"string"`
}
// String returns the string representation
-func (s AwsElasticBeanstalkEnvironmentTier) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElasticBeanstalkEnvironmentTier) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) GoString() string {
return s.String()
}
-// SetName sets the Name field's value.
-func (s *AwsElasticBeanstalkEnvironmentTier) SetName(v string) *AwsElasticBeanstalkEnvironmentTier {
- s.Name = &v
- return s
-}
-
-// SetType sets the Type field's value.
-func (s *AwsElasticBeanstalkEnvironmentTier) SetType(v string) *AwsElasticBeanstalkEnvironmentTier {
- s.Type = &v
+// SetCondition sets the Condition field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetCondition(v string) *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails {
+ s.Condition = &v
return s
}
-// SetVersion sets the Version field's value.
-func (s *AwsElasticBeanstalkEnvironmentTier) SetVersion(v string) *AwsElasticBeanstalkEnvironmentTier {
- s.Version = &v
+// SetContainerName sets the ContainerName field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) SetContainerName(v string) *AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails {
+ s.ContainerName = &v
return s
}
-// Information about an Elasticsearch domain.
-type AwsElasticsearchDomainDetails struct {
+// A container definition that describes a container in the task.
+type AwsEcsTaskDefinitionContainerDefinitionsDetails struct {
_ struct{} `type:"structure"`
- // IAM policy document specifying the access policies for the new Amazon ES
- // domain.
- AccessPolicies *string `type:"string"`
+ // The command that is passed to the container.
+ Command []*string `type:"list"`
- // Additional options for the domain endpoint.
- DomainEndpointOptions *AwsElasticsearchDomainDomainEndpointOptions `type:"structure"`
+ // The number of CPU units reserved for the container.
+ Cpu *int64 `type:"integer"`
- // Unique identifier for an Amazon ES domain.
- DomainId *string `type:"string"`
+ // The dependencies that are defined for container startup and shutdown.
+ DependsOn []*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails `type:"list"`
- // Name of an Amazon ES domain.
- //
- // Domain names are unique across all domains owned by the same account within
- // an AWS Region.
- //
- // Domain names must start with a lowercase letter and must be between 3 and
- // 28 characters.
- //
- // Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
- DomainName *string `type:"string"`
+ // Whether to disable networking within the container.
+ DisableNetworking *bool `type:"boolean"`
- // Elasticsearch version.
- ElasticsearchVersion *string `type:"string"`
+ // A list of DNS search domains that are presented to the container.
+ DnsSearchDomains []*string `type:"list"`
- // Details about the configuration for encryption at rest.
- EncryptionAtRestOptions *AwsElasticsearchDomainEncryptionAtRestOptions `type:"structure"`
+ // A list of DNS servers that are presented to the container.
+ DnsServers []*string `type:"list"`
- // Domain-specific endpoint used to submit index, search, and data upload requests
- // to an Amazon ES domain.
- //
- // The endpoint is a service URL.
- Endpoint *string `type:"string"`
+ // A key-value map of labels to add to the container.
+ DockerLabels map[string]*string `type:"map"`
- // The key-value pair that exists if the Amazon ES domain uses VPC endpoints.
- Endpoints map[string]*string `type:"map"`
+ // A list of strings to provide custom labels for SELinux and AppArmor multi-level
+ // security systems.
+ DockerSecurityOptions []*string `type:"list"`
- // Details about the configuration for node-to-node encryption.
- NodeToNodeEncryptionOptions *AwsElasticsearchDomainNodeToNodeEncryptionOptions `type:"structure"`
+ // The entry point that is passed to the container.
+ EntryPoint []*string `type:"list"`
- // Information that Amazon ES derives based on VPCOptions for the domain.
- VPCOptions *AwsElasticsearchDomainVPCOptions `type:"structure"`
+ // The environment variables to pass to a container.
+ Environment []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails `type:"list"`
+
+ // A list of files containing the environment variables to pass to a container.
+ EnvironmentFiles []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails `type:"list"`
+
+ // Whether the container is essential. All tasks must have at least one essential
+ // container.
+ Essential *bool `type:"boolean"`
+
+ // A list of hostnames and IP address mappings to append to the /etc/hosts file
+ // on the container.
+ ExtraHosts []*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails `type:"list"`
+
+ // The FireLens configuration for the container. Specifies and configures a
+ // log router for container logs.
+ FirelensConfiguration *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails `type:"structure"`
+
+ // The container health check command and associated configuration parameters
+ // for the container.
+ HealthCheck *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails `type:"structure"`
+
+ // The hostname to use for the container.
+ Hostname *string `type:"string"`
+
+ // The image used to start the container.
+ Image *string `type:"string"`
+
+ // If set to true, then containerized applications can be deployed that require
+ // stdin or a tty to be allocated.
+ Interactive *bool `type:"boolean"`
+
+ // A list of links for the container in the form container_name:alias . Allows
+ // containers to communicate with each other without the need for port mappings.
+ Links []*string `type:"list"`
+
+ // Linux-specific modifications that are applied to the container, such as Linux
+ // kernel capabilities.
+ LinuxParameters *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails `type:"structure"`
+
+ // The log configuration specification for the container.
+ LogConfiguration *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails `type:"structure"`
+
+ // The amount (in MiB) of memory to present to the container. If the container
+ // attempts to exceed the memory specified here, the container is shut down.
+ // The total amount of memory reserved for all containers within a task must
+ // be lower than the task memory value, if one is specified.
+ Memory *int64 `type:"integer"`
+
+ // The soft limit (in MiB) of memory to reserve for the container.
+ MemoryReservation *int64 `type:"integer"`
+
+ // The mount points for the data volumes in the container.
+ MountPoints []*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails `type:"list"`
+
+ // The name of the container.
+ Name *string `type:"string"`
+
+ // The list of port mappings for the container.
+ PortMappings []*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails `type:"list"`
+
+ // Whether the container is given elevated privileges on the host container
+ // instance. The elevated privileges are similar to the root user.
+ Privileged *bool `type:"boolean"`
+
+ // Whether to allocate a TTY to the container.
+ PseudoTerminal *bool `type:"boolean"`
+
+ // Whether the container is given read-only access to its root file system.
+ ReadonlyRootFilesystem *bool `type:"boolean"`
+
+ // The private repository authentication credentials to use.
+ RepositoryCredentials *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails `type:"structure"`
+
+ // The type and amount of a resource to assign to a container. The only supported
+ // resource is a GPU.
+ ResourceRequirements []*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails `type:"list"`
+
+ // The secrets to pass to the container.
+ Secrets []*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails `type:"list"`
+
+ // The number of seconds to wait before giving up on resolving dependencies
+ // for a container.
+ StartTimeout *int64 `type:"integer"`
+
+ // The number of seconds to wait before the container is stopped if it doesn't
+ // shut down normally on its own.
+ StopTimeout *int64 `type:"integer"`
+
+ // A list of namespaced kernel parameters to set in the container.
+ SystemControls []*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails `type:"list"`
+
+ // A list of ulimits to set in the container.
+ Ulimits []*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails `type:"list"`
+
+ // The user to use inside the container.
+ //
+ // The value can use one of the following formats.
+ //
+ // * user
+ //
+ // * user :group
+ //
+ // * uid
+ //
+ // * uid :gid
+ //
+ // * user :gid
+ //
+ // * uid :group
+ User *string `type:"string"`
+
+ // Data volumes to mount from another container.
+ VolumesFrom []*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails `type:"list"`
+
+ // The working directory in which to run commands inside the container.
+ WorkingDirectory *string `type:"string"`
}
// String returns the string representation
-func (s AwsElasticsearchDomainDetails) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElasticsearchDomainDetails) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsDetails) GoString() string {
return s.String()
}
-// SetAccessPolicies sets the AccessPolicies field's value.
-func (s *AwsElasticsearchDomainDetails) SetAccessPolicies(v string) *AwsElasticsearchDomainDetails {
- s.AccessPolicies = &v
+// SetCommand sets the Command field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCommand(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Command = v
return s
}
-// SetDomainEndpointOptions sets the DomainEndpointOptions field's value.
-func (s *AwsElasticsearchDomainDetails) SetDomainEndpointOptions(v *AwsElasticsearchDomainDomainEndpointOptions) *AwsElasticsearchDomainDetails {
- s.DomainEndpointOptions = v
+// SetCpu sets the Cpu field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetCpu(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Cpu = &v
return s
}
-// SetDomainId sets the DomainId field's value.
-func (s *AwsElasticsearchDomainDetails) SetDomainId(v string) *AwsElasticsearchDomainDetails {
- s.DomainId = &v
+// SetDependsOn sets the DependsOn field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDependsOn(v []*AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DependsOn = v
return s
}
-// SetDomainName sets the DomainName field's value.
-func (s *AwsElasticsearchDomainDetails) SetDomainName(v string) *AwsElasticsearchDomainDetails {
- s.DomainName = &v
+// SetDisableNetworking sets the DisableNetworking field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDisableNetworking(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DisableNetworking = &v
return s
}
-// SetElasticsearchVersion sets the ElasticsearchVersion field's value.
-func (s *AwsElasticsearchDomainDetails) SetElasticsearchVersion(v string) *AwsElasticsearchDomainDetails {
- s.ElasticsearchVersion = &v
+// SetDnsSearchDomains sets the DnsSearchDomains field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsSearchDomains(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DnsSearchDomains = v
return s
}
-// SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.
-func (s *AwsElasticsearchDomainDetails) SetEncryptionAtRestOptions(v *AwsElasticsearchDomainEncryptionAtRestOptions) *AwsElasticsearchDomainDetails {
- s.EncryptionAtRestOptions = v
+// SetDnsServers sets the DnsServers field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDnsServers(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DnsServers = v
return s
}
-// SetEndpoint sets the Endpoint field's value.
-func (s *AwsElasticsearchDomainDetails) SetEndpoint(v string) *AwsElasticsearchDomainDetails {
- s.Endpoint = &v
+// SetDockerLabels sets the DockerLabels field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerLabels(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DockerLabels = v
return s
}
-// SetEndpoints sets the Endpoints field's value.
-func (s *AwsElasticsearchDomainDetails) SetEndpoints(v map[string]*string) *AwsElasticsearchDomainDetails {
- s.Endpoints = v
+// SetDockerSecurityOptions sets the DockerSecurityOptions field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetDockerSecurityOptions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.DockerSecurityOptions = v
return s
}
-// SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.
-func (s *AwsElasticsearchDomainDetails) SetNodeToNodeEncryptionOptions(v *AwsElasticsearchDomainNodeToNodeEncryptionOptions) *AwsElasticsearchDomainDetails {
- s.NodeToNodeEncryptionOptions = v
+// SetEntryPoint sets the EntryPoint field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEntryPoint(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.EntryPoint = v
return s
}
-// SetVPCOptions sets the VPCOptions field's value.
-func (s *AwsElasticsearchDomainDetails) SetVPCOptions(v *AwsElasticsearchDomainVPCOptions) *AwsElasticsearchDomainDetails {
- s.VPCOptions = v
+// SetEnvironment sets the Environment field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironment(v []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Environment = v
return s
}
-// Additional options for the domain endpoint, such as whether to require HTTPS
-// for all traffic.
-type AwsElasticsearchDomainDomainEndpointOptions struct {
- _ struct{} `type:"structure"`
-
- // Whether to require that all traffic to the domain arrive over HTTPS.
- EnforceHTTPS *bool `type:"boolean"`
+// SetEnvironmentFiles sets the EnvironmentFiles field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEnvironmentFiles(v []*AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.EnvironmentFiles = v
+ return s
+}
- // The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch
- // domain.
- //
- // Valid values:
- //
- // * Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
- //
- // * Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
- TLSSecurityPolicy *string `type:"string"`
+// SetEssential sets the Essential field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetEssential(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Essential = &v
+ return s
}
-// String returns the string representation
-func (s AwsElasticsearchDomainDomainEndpointOptions) String() string {
- return awsutil.Prettify(s)
+// SetExtraHosts sets the ExtraHosts field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetExtraHosts(v []*AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.ExtraHosts = v
+ return s
}
-// GoString returns the string representation
-func (s AwsElasticsearchDomainDomainEndpointOptions) GoString() string {
- return s.String()
+// SetFirelensConfiguration sets the FirelensConfiguration field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetFirelensConfiguration(v *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.FirelensConfiguration = v
+ return s
}
-// SetEnforceHTTPS sets the EnforceHTTPS field's value.
-func (s *AwsElasticsearchDomainDomainEndpointOptions) SetEnforceHTTPS(v bool) *AwsElasticsearchDomainDomainEndpointOptions {
- s.EnforceHTTPS = &v
+// SetHealthCheck sets the HealthCheck field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHealthCheck(v *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.HealthCheck = v
return s
}
-// SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.
-func (s *AwsElasticsearchDomainDomainEndpointOptions) SetTLSSecurityPolicy(v string) *AwsElasticsearchDomainDomainEndpointOptions {
- s.TLSSecurityPolicy = &v
+// SetHostname sets the Hostname field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetHostname(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Hostname = &v
return s
}
-// Details about the configuration for encryption at rest.
-type AwsElasticsearchDomainEncryptionAtRestOptions struct {
- _ struct{} `type:"structure"`
+// SetImage sets the Image field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetImage(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Image = &v
+ return s
+}
- // Whether encryption at rest is enabled.
- Enabled *bool `type:"boolean"`
+// SetInteractive sets the Interactive field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetInteractive(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Interactive = &v
+ return s
+}
- // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
- KmsKeyId *string `type:"string"`
+// SetLinks sets the Links field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinks(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Links = v
+ return s
}
-// String returns the string representation
-func (s AwsElasticsearchDomainEncryptionAtRestOptions) String() string {
- return awsutil.Prettify(s)
+// SetLinuxParameters sets the LinuxParameters field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLinuxParameters(v *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.LinuxParameters = v
+ return s
}
-// GoString returns the string representation
-func (s AwsElasticsearchDomainEncryptionAtRestOptions) GoString() string {
- return s.String()
+// SetLogConfiguration sets the LogConfiguration field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetLogConfiguration(v *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.LogConfiguration = v
+ return s
}
-// SetEnabled sets the Enabled field's value.
-func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetEnabled(v bool) *AwsElasticsearchDomainEncryptionAtRestOptions {
- s.Enabled = &v
+// SetMemory sets the Memory field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemory(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Memory = &v
return s
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetKmsKeyId(v string) *AwsElasticsearchDomainEncryptionAtRestOptions {
- s.KmsKeyId = &v
+// SetMemoryReservation sets the MemoryReservation field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMemoryReservation(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.MemoryReservation = &v
return s
}
-// Details about the configuration for node-to-node encryption.
-type AwsElasticsearchDomainNodeToNodeEncryptionOptions struct {
- _ struct{} `type:"structure"`
+// SetMountPoints sets the MountPoints field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetMountPoints(v []*AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.MountPoints = v
+ return s
+}
- // Whether node-to-node encryption is enabled.
- Enabled *bool `type:"boolean"`
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetName(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Name = &v
+ return s
}
-// String returns the string representation
-func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) String() string {
- return awsutil.Prettify(s)
+// SetPortMappings sets the PortMappings field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPortMappings(v []*AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.PortMappings = v
+ return s
}
-// GoString returns the string representation
-func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) GoString() string {
- return s.String()
+// SetPrivileged sets the Privileged field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPrivileged(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Privileged = &v
+ return s
}
-// SetEnabled sets the Enabled field's value.
-func (s *AwsElasticsearchDomainNodeToNodeEncryptionOptions) SetEnabled(v bool) *AwsElasticsearchDomainNodeToNodeEncryptionOptions {
- s.Enabled = &v
+// SetPseudoTerminal sets the PseudoTerminal field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetPseudoTerminal(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.PseudoTerminal = &v
return s
}
-// Information that Amazon ES derives based on VPCOptions for the domain.
-type AwsElasticsearchDomainVPCOptions struct {
- _ struct{} `type:"structure"`
+// SetReadonlyRootFilesystem sets the ReadonlyRootFilesystem field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetReadonlyRootFilesystem(v bool) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.ReadonlyRootFilesystem = &v
+ return s
+}
- // The list of Availability Zones associated with the VPC subnets.
- AvailabilityZones []*string `type:"list"`
+// SetRepositoryCredentials sets the RepositoryCredentials field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetRepositoryCredentials(v *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.RepositoryCredentials = v
+ return s
+}
- // The list of security group IDs associated with the VPC endpoints for the
- // domain.
- SecurityGroupIds []*string `type:"list"`
+// SetResourceRequirements sets the ResourceRequirements field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetResourceRequirements(v []*AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.ResourceRequirements = v
+ return s
+}
- // A list of subnet IDs associated with the VPC endpoints for the domain.
- SubnetIds []*string `type:"list"`
+// SetSecrets sets the Secrets field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSecrets(v []*AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Secrets = v
+ return s
+}
- // ID for the VPC.
- VPCId *string `type:"string"`
+// SetStartTimeout sets the StartTimeout field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStartTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.StartTimeout = &v
+ return s
}
-// String returns the string representation
-func (s AwsElasticsearchDomainVPCOptions) String() string {
- return awsutil.Prettify(s)
+// SetStopTimeout sets the StopTimeout field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetStopTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.StopTimeout = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsElasticsearchDomainVPCOptions) GoString() string {
- return s.String()
+// SetSystemControls sets the SystemControls field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetSystemControls(v []*AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.SystemControls = v
+ return s
}
-// SetAvailabilityZones sets the AvailabilityZones field's value.
-func (s *AwsElasticsearchDomainVPCOptions) SetAvailabilityZones(v []*string) *AwsElasticsearchDomainVPCOptions {
- s.AvailabilityZones = v
+// SetUlimits sets the Ulimits field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUlimits(v []*AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.Ulimits = v
return s
}
-// SetSecurityGroupIds sets the SecurityGroupIds field's value.
-func (s *AwsElasticsearchDomainVPCOptions) SetSecurityGroupIds(v []*string) *AwsElasticsearchDomainVPCOptions {
- s.SecurityGroupIds = v
+// SetUser sets the User field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetUser(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.User = &v
return s
}
-// SetSubnetIds sets the SubnetIds field's value.
-func (s *AwsElasticsearchDomainVPCOptions) SetSubnetIds(v []*string) *AwsElasticsearchDomainVPCOptions {
- s.SubnetIds = v
+// SetVolumesFrom sets the VolumesFrom field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetVolumesFrom(v []*AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.VolumesFrom = v
return s
}
-// SetVPCId sets the VPCId field's value.
-func (s *AwsElasticsearchDomainVPCOptions) SetVPCId(v string) *AwsElasticsearchDomainVPCOptions {
- s.VPCId = &v
+// SetWorkingDirectory sets the WorkingDirectory field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsDetails) SetWorkingDirectory(v string) *AwsEcsTaskDefinitionContainerDefinitionsDetails {
+ s.WorkingDirectory = &v
return s
}
-// Contains information about a stickiness policy that was created using CreateAppCookieStickinessPolicy.
-type AwsElbAppCookieStickinessPolicy struct {
+// An environment variable to pass to the container.
+type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails struct {
_ struct{} `type:"structure"`
- // The name of the application cookie used for stickiness.
- CookieName *string `type:"string"`
+ // The name of the environment variable.
+ Name *string `type:"string"`
- // The mnemonic name for the policy being created. The name must be unique within
- // the set of policies for the load balancer.
- PolicyName *string `type:"string"`
+ // The value of the environment variable.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbAppCookieStickinessPolicy) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbAppCookieStickinessPolicy) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) GoString() string {
return s.String()
}
-// SetCookieName sets the CookieName field's value.
-func (s *AwsElbAppCookieStickinessPolicy) SetCookieName(v string) *AwsElbAppCookieStickinessPolicy {
- s.CookieName = &v
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetName(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails {
+ s.Name = &v
return s
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsElbAppCookieStickinessPolicy) SetPolicyName(v string) *AwsElbAppCookieStickinessPolicy {
- s.PolicyName = &v
+// SetValue sets the Value field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails {
+ s.Value = &v
return s
}
-// Contains information about a stickiness policy that was created using CreateLBCookieStickinessPolicy.
-type AwsElbLbCookieStickinessPolicy struct {
+// A file that contain environment variables to pass to a container.
+type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails struct {
_ struct{} `type:"structure"`
- // The amount of time, in seconds, after which the cookie is considered stale.
- // If an expiration period is not specified, the stickiness session lasts for
- // the duration of the browser session.
- CookieExpirationPeriod *int64 `type:"long"`
+ // The type of environment file.
+ Type *string `type:"string"`
- // The name of the policy. The name must be unique within the set of policies
- // for the load balancer.
- PolicyName *string `type:"string"`
+ // The ARN of the S3 object that contains the environment variable file.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLbCookieStickinessPolicy) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLbCookieStickinessPolicy) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) GoString() string {
return s.String()
}
-// SetCookieExpirationPeriod sets the CookieExpirationPeriod field's value.
-func (s *AwsElbLbCookieStickinessPolicy) SetCookieExpirationPeriod(v int64) *AwsElbLbCookieStickinessPolicy {
- s.CookieExpirationPeriod = &v
+// SetType sets the Type field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails {
+ s.Type = &v
return s
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsElbLbCookieStickinessPolicy) SetPolicyName(v string) *AwsElbLbCookieStickinessPolicy {
- s.PolicyName = &v
+// SetValue sets the Value field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails {
+ s.Value = &v
return s
}
-// Contains information about the access log configuration for the load balancer.
-type AwsElbLoadBalancerAccessLog struct {
+// A hostname and IP address mapping to append to the /etc/hosts file on the
+// container.
+type AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails struct {
_ struct{} `type:"structure"`
- // The interval in minutes for publishing the access logs.
- //
- // You can publish access logs either every 5 minutes or every 60 minutes.
- EmitInterval *int64 `type:"integer"`
-
- // Indicates whether access logs are enabled for the load balancer.
- Enabled *bool `type:"boolean"`
-
- // The name of the S3 bucket where the access logs are stored.
- S3BucketName *string `type:"string"`
+ // The hostname to use in the /etc/hosts entry.
+ Hostname *string `type:"string"`
- // The logical hierarchy that was created for the S3 bucket.
- //
- // If a prefix is not provided, the log is placed at the root level of the bucket.
- S3BucketPrefix *string `type:"string"`
+ // The IP address to use in the /etc/hosts entry.
+ IpAddress *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerAccessLog) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerAccessLog) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) GoString() string {
return s.String()
}
-// SetEmitInterval sets the EmitInterval field's value.
-func (s *AwsElbLoadBalancerAccessLog) SetEmitInterval(v int64) *AwsElbLoadBalancerAccessLog {
- s.EmitInterval = &v
+// SetHostname sets the Hostname field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetHostname(v string) *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails {
+ s.Hostname = &v
return s
}
-// SetEnabled sets the Enabled field's value.
-func (s *AwsElbLoadBalancerAccessLog) SetEnabled(v bool) *AwsElbLoadBalancerAccessLog {
- s.Enabled = &v
+// SetIpAddress sets the IpAddress field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails) SetIpAddress(v string) *AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails {
+ s.IpAddress = &v
return s
}
-// SetS3BucketName sets the S3BucketName field's value.
-func (s *AwsElbLoadBalancerAccessLog) SetS3BucketName(v string) *AwsElbLoadBalancerAccessLog {
- s.S3BucketName = &v
+// The FireLens configuration for the container. The configuration specifies
+// and configures a log router for container logs.
+type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The options to use to configure the log router.
+ //
+ // The valid option keys are as follows:
+ //
+ // * enable-ecs-log-metadata. The value can be true or false.
+ //
+ // * config-file-type. The value can be s3 or file.
+ //
+ // * config-file-value. The value is either an S3 ARN or a file path.
+ Options map[string]*string `type:"map"`
+
+ // The log router to use.
+ Type *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) GoString() string {
+ return s.String()
+}
+
+// SetOptions sets the Options field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetOptions(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails {
+ s.Options = v
return s
}
-// SetS3BucketPrefix sets the S3BucketPrefix field's value.
-func (s *AwsElbLoadBalancerAccessLog) SetS3BucketPrefix(v string) *AwsElbLoadBalancerAccessLog {
- s.S3BucketPrefix = &v
+// SetType sets the Type field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails {
+ s.Type = &v
return s
}
-// Contains attributes for the load balancer.
-type AwsElbLoadBalancerAttributes struct {
+// The container health check command and associated configuration parameters
+// for the container.
+type AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails struct {
_ struct{} `type:"structure"`
- // Information about the access log configuration for the load balancer.
- //
- // If the access log is enabled, the load balancer captures detailed information
- // about all requests. It delivers the information to a specified S3 bucket.
- AccessLog *AwsElbLoadBalancerAccessLog `type:"structure"`
+ // The command that the container runs to determine whether it is healthy.
+ Command []*string `type:"list"`
- // Information about the connection draining configuration for the load balancer.
- //
- // If connection draining is enabled, the load balancer allows existing requests
- // to complete before it shifts traffic away from a deregistered or unhealthy
- // instance.
- ConnectionDraining *AwsElbLoadBalancerConnectionDraining `type:"structure"`
+ // The time period in seconds between each health check execution. The default
+ // value is 30 seconds.
+ Interval *int64 `type:"integer"`
- // Connection settings for the load balancer.
- //
- // If an idle timeout is configured, the load balancer allows connections to
- // remain idle for the specified duration. When a connection is idle, no data
- // is sent over the connection.
- ConnectionSettings *AwsElbLoadBalancerConnectionSettings `type:"structure"`
+ // The number of times to retry a failed health check before the container is
+ // considered unhealthy. The default value is 3.
+ Retries *int64 `type:"integer"`
- // Cross-zone load balancing settings for the load balancer.
- //
- // If cross-zone load balancing is enabled, the load balancer routes the request
- // traffic evenly across all instances regardless of the Availability Zones.
- CrossZoneLoadBalancing *AwsElbLoadBalancerCrossZoneLoadBalancing `type:"structure"`
+ // The optional grace period in seconds that allows containers time to bootstrap
+ // before failed health checks count towards the maximum number of retries.
+ StartPeriod *int64 `type:"integer"`
+
+ // The time period in seconds to wait for a health check to succeed before it
+ // is considered a failure. The default value is 5.
+ Timeout *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerAttributes) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerAttributes) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) GoString() string {
return s.String()
}
-// SetAccessLog sets the AccessLog field's value.
-func (s *AwsElbLoadBalancerAttributes) SetAccessLog(v *AwsElbLoadBalancerAccessLog) *AwsElbLoadBalancerAttributes {
- s.AccessLog = v
+// SetCommand sets the Command field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetCommand(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
+ s.Command = v
return s
}
-// SetConnectionDraining sets the ConnectionDraining field's value.
-func (s *AwsElbLoadBalancerAttributes) SetConnectionDraining(v *AwsElbLoadBalancerConnectionDraining) *AwsElbLoadBalancerAttributes {
- s.ConnectionDraining = v
+// SetInterval sets the Interval field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetInterval(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
+ s.Interval = &v
return s
}
-// SetConnectionSettings sets the ConnectionSettings field's value.
-func (s *AwsElbLoadBalancerAttributes) SetConnectionSettings(v *AwsElbLoadBalancerConnectionSettings) *AwsElbLoadBalancerAttributes {
- s.ConnectionSettings = v
+// SetRetries sets the Retries field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetRetries(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
+ s.Retries = &v
return s
}
-// SetCrossZoneLoadBalancing sets the CrossZoneLoadBalancing field's value.
-func (s *AwsElbLoadBalancerAttributes) SetCrossZoneLoadBalancing(v *AwsElbLoadBalancerCrossZoneLoadBalancing) *AwsElbLoadBalancerAttributes {
- s.CrossZoneLoadBalancing = v
+// SetStartPeriod sets the StartPeriod field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetStartPeriod(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
+ s.StartPeriod = &v
return s
}
-// Provides information about the configuration of an EC2 instance for the load
-// balancer.
-type AwsElbLoadBalancerBackendServerDescription struct {
+// SetTimeout sets the Timeout field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails) SetTimeout(v int64) *AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
+ s.Timeout = &v
+ return s
+}
+
+// The Linux capabilities for the container that are added to or dropped from
+// the default configuration provided by Docker.
+type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails struct {
_ struct{} `type:"structure"`
- // The port on which the EC2 instance is listening.
- InstancePort *int64 `type:"integer"`
+ // The Linux capabilities for the container that are added to the default configuration
+ // provided by Docker.
+ Add []*string `type:"list"`
- // The names of the policies that are enabled for the EC2 instance.
- PolicyNames []*string `type:"list"`
+ // The Linux capabilities for the container that are dropped from the default
+ // configuration provided by Docker.
+ Drop []*string `type:"list"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerBackendServerDescription) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerBackendServerDescription) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) GoString() string {
return s.String()
}
-// SetInstancePort sets the InstancePort field's value.
-func (s *AwsElbLoadBalancerBackendServerDescription) SetInstancePort(v int64) *AwsElbLoadBalancerBackendServerDescription {
- s.InstancePort = &v
+// SetAdd sets the Add field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetAdd(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails {
+ s.Add = v
return s
}
-// SetPolicyNames sets the PolicyNames field's value.
-func (s *AwsElbLoadBalancerBackendServerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerBackendServerDescription {
- s.PolicyNames = v
+// SetDrop sets the Drop field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) SetDrop(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails {
+ s.Drop = v
return s
}
-// Contains information about the connection draining configuration for the
-// load balancer.
-type AwsElbLoadBalancerConnectionDraining struct {
+// >Linux-specific modifications that are applied to the container, such as
+// Linux kernel capabilities.
+type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails struct {
_ struct{} `type:"structure"`
- // Indicates whether connection draining is enabled for the load balancer.
- Enabled *bool `type:"boolean"`
+ // The Linux capabilities for the container that are added to or dropped from
+ // the default configuration provided by Docker.
+ Capabilities *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails `type:"structure"`
- // The maximum time, in seconds, to keep the existing connections open before
- // deregistering the instances.
- Timeout *int64 `type:"integer"`
+ // The host devices to expose to the container.
+ Devices []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails `type:"list"`
+
+ // Whether to run an init process inside the container that forwards signals
+ // and reaps processes.
+ InitProcessEnabled *bool `type:"boolean"`
+
+ // The total amount of swap memory (in MiB) that a container can use.
+ MaxSwap *int64 `type:"integer"`
+
+ // The value for the size (in MiB) of the /dev/shm volume.
+ SharedMemorySize *int64 `type:"integer"`
+
+ // Configures the container's memory swappiness behavior. Determines how aggressively
+ // pages are swapped. The higher the value, the more aggressive the swappiness.
+ // The default is 60.
+ Swappiness *int64 `type:"integer"`
+
+ // The container path, mount options, and size (in MiB) of the tmpfs mount.
+ Tmpfs []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails `type:"list"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerConnectionDraining) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerConnectionDraining) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) GoString() string {
return s.String()
}
-// SetEnabled sets the Enabled field's value.
-func (s *AwsElbLoadBalancerConnectionDraining) SetEnabled(v bool) *AwsElbLoadBalancerConnectionDraining {
- s.Enabled = &v
+// SetCapabilities sets the Capabilities field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetCapabilities(v *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.Capabilities = v
return s
}
-// SetTimeout sets the Timeout field's value.
-func (s *AwsElbLoadBalancerConnectionDraining) SetTimeout(v int64) *AwsElbLoadBalancerConnectionDraining {
- s.Timeout = &v
+// SetDevices sets the Devices field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetDevices(v []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.Devices = v
return s
}
-// Contains connection settings for the load balancer.
-type AwsElbLoadBalancerConnectionSettings struct {
- _ struct{} `type:"structure"`
+// SetInitProcessEnabled sets the InitProcessEnabled field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetInitProcessEnabled(v bool) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.InitProcessEnabled = &v
+ return s
+}
- // The time, in seconds, that the connection can be idle (no data is sent over
- // the connection) before it is closed by the load balancer.
- IdleTimeout *int64 `type:"integer"`
+// SetMaxSwap sets the MaxSwap field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetMaxSwap(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.MaxSwap = &v
+ return s
}
-// String returns the string representation
-func (s AwsElbLoadBalancerConnectionSettings) String() string {
- return awsutil.Prettify(s)
+// SetSharedMemorySize sets the SharedMemorySize field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSharedMemorySize(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.SharedMemorySize = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsElbLoadBalancerConnectionSettings) GoString() string {
- return s.String()
+// SetSwappiness sets the Swappiness field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetSwappiness(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.Swappiness = &v
+ return s
}
-// SetIdleTimeout sets the IdleTimeout field's value.
-func (s *AwsElbLoadBalancerConnectionSettings) SetIdleTimeout(v int64) *AwsElbLoadBalancerConnectionSettings {
- s.IdleTimeout = &v
+// SetTmpfs sets the Tmpfs field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails) SetTmpfs(v []*AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
+ s.Tmpfs = v
return s
}
-// Contains cross-zone load balancing settings for the load balancer.
-type AwsElbLoadBalancerCrossZoneLoadBalancing struct {
+// A host device to expose to the container.
+type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails struct {
_ struct{} `type:"structure"`
- // Indicates whether cross-zone load balancing is enabled for the load balancer.
- Enabled *bool `type:"boolean"`
+ // The path inside the container at which to expose the host device.
+ ContainerPath *string `type:"string"`
+
+ // The path for the device on the host container instance.
+ HostPath *string `type:"string"`
+
+ // The explicit permissions to provide to the container for the device. By default,
+ // the container has permissions for read, write, and mknod for the device.
+ Permissions []*string `type:"list"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerCrossZoneLoadBalancing) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerCrossZoneLoadBalancing) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) GoString() string {
return s.String()
}
-// SetEnabled sets the Enabled field's value.
-func (s *AwsElbLoadBalancerCrossZoneLoadBalancing) SetEnabled(v bool) *AwsElbLoadBalancerCrossZoneLoadBalancing {
- s.Enabled = &v
+// SetContainerPath sets the ContainerPath field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails {
+ s.ContainerPath = &v
return s
}
-// Contains details about a Classic Load Balancer.
-type AwsElbLoadBalancerDetails struct {
- _ struct{} `type:"structure"`
-
- // The list of Availability Zones for the load balancer.
- AvailabilityZones []*string `type:"list"`
-
- // Information about the configuration of the EC2 instances.
- BackendServerDescriptions []*AwsElbLoadBalancerBackendServerDescription `type:"list"`
-
- // The name of the Amazon Route 53 hosted zone for the load balancer.
- CanonicalHostedZoneName *string `type:"string"`
+// SetHostPath sets the HostPath field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetHostPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails {
+ s.HostPath = &v
+ return s
+}
- // The ID of the Amazon Route 53 hosted zone for the load balancer.
- CanonicalHostedZoneNameID *string `type:"string"`
+// SetPermissions sets the Permissions field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails) SetPermissions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails {
+ s.Permissions = v
+ return s
+}
- // Indicates when the load balancer was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreatedTime *string `type:"string"`
+// The container path, mount options, and size (in MiB) of a tmpfs mount.
+type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails struct {
+ _ struct{} `type:"structure"`
- // The DNS name of the load balancer.
- DnsName *string `type:"string"`
+ // The absolute file path where the tmpfs volume is to be mounted.
+ ContainerPath *string `type:"string"`
- // Information about the health checks that are conducted on the load balancer.
- HealthCheck *AwsElbLoadBalancerHealthCheck `type:"structure"`
+ // The list of tmpfs volume mount options.
+ MountOptions []*string `type:"list"`
- // List of EC2 instances for the load balancer.
- Instances []*AwsElbLoadBalancerInstance `type:"list"`
+ // The maximum size (in MiB) of the tmpfs volume.
+ Size *int64 `type:"integer"`
+}
- // The policies that are enabled for the load balancer listeners.
- ListenerDescriptions []*AwsElbLoadBalancerListenerDescription `type:"list"`
+// String returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // The attributes for a load balancer.
- LoadBalancerAttributes *AwsElbLoadBalancerAttributes `type:"structure"`
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) GoString() string {
+ return s.String()
+}
- // The name of the load balancer.
- LoadBalancerName *string `type:"string"`
+// SetContainerPath sets the ContainerPath field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails {
+ s.ContainerPath = &v
+ return s
+}
- // The policies for a load balancer.
- Policies *AwsElbLoadBalancerPolicies `type:"structure"`
+// SetMountOptions sets the MountOptions field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetMountOptions(v []*string) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails {
+ s.MountOptions = v
+ return s
+}
- // The type of load balancer. Only provided if the load balancer is in a VPC.
- //
- // If Scheme is internet-facing, the load balancer has a public DNS name that
- // resolves to a public IP address.
- //
- // If Scheme is internal, the load balancer has a public DNS name that resolves
- // to a private IP address.
- Scheme *string `type:"string"`
+// SetSize sets the Size field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails) SetSize(v int64) *AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails {
+ s.Size = &v
+ return s
+}
- // The security groups for the load balancer. Only provided if the load balancer
- // is in a VPC.
- SecurityGroups []*string `type:"list"`
+// The log configuration specification for the container.
+type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails struct {
+ _ struct{} `type:"structure"`
- // Information about the security group for the load balancer. This is the security
- // group that is used for inbound rules.
- SourceSecurityGroup *AwsElbLoadBalancerSourceSecurityGroup `type:"structure"`
+ // The log driver to use for the container.
+ LogDriver *string `type:"string"`
- // The list of subnet identifiers for the load balancer.
- Subnets []*string `type:"list"`
+ // The configuration options to send to the log driver. Requires version 1.19
+ // of the Docker Remote API or greater on your container instance.
+ Options map[string]*string `type:"map"`
- // The identifier of the VPC for the load balancer.
- VpcId *string `type:"string"`
+ // The secrets to pass to the log configuration.
+ SecretOptions []*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails `type:"list"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerDetails) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerDetails) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) GoString() string {
return s.String()
}
-// SetAvailabilityZones sets the AvailabilityZones field's value.
-func (s *AwsElbLoadBalancerDetails) SetAvailabilityZones(v []*string) *AwsElbLoadBalancerDetails {
- s.AvailabilityZones = v
+// SetLogDriver sets the LogDriver field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetLogDriver(v string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails {
+ s.LogDriver = &v
return s
}
-// SetBackendServerDescriptions sets the BackendServerDescriptions field's value.
-func (s *AwsElbLoadBalancerDetails) SetBackendServerDescriptions(v []*AwsElbLoadBalancerBackendServerDescription) *AwsElbLoadBalancerDetails {
- s.BackendServerDescriptions = v
+// SetOptions sets the Options field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetOptions(v map[string]*string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails {
+ s.Options = v
return s
}
-// SetCanonicalHostedZoneName sets the CanonicalHostedZoneName field's value.
-func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName(v string) *AwsElbLoadBalancerDetails {
- s.CanonicalHostedZoneName = &v
+// SetSecretOptions sets the SecretOptions field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails) SetSecretOptions(v []*AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails {
+ s.SecretOptions = v
return s
}
-// SetCanonicalHostedZoneNameID sets the CanonicalHostedZoneNameID field's value.
-func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID(v string) *AwsElbLoadBalancerDetails {
- s.CanonicalHostedZoneNameID = &v
- return s
-}
+// A secret to pass to the log configuration.
+type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails struct {
+ _ struct{} `type:"structure"`
-// SetCreatedTime sets the CreatedTime field's value.
-func (s *AwsElbLoadBalancerDetails) SetCreatedTime(v string) *AwsElbLoadBalancerDetails {
- s.CreatedTime = &v
- return s
-}
+ // The name of the secret.
+ Name *string `type:"string"`
-// SetDnsName sets the DnsName field's value.
-func (s *AwsElbLoadBalancerDetails) SetDnsName(v string) *AwsElbLoadBalancerDetails {
- s.DnsName = &v
- return s
+ // The secret to expose to the container.
+ //
+ // The value is either the full ARN of the Secrets Manager secret or the full
+ // ARN of the parameter in the Systems Manager Parameter Store.
+ ValueFrom *string `type:"string"`
}
-// SetHealthCheck sets the HealthCheck field's value.
-func (s *AwsElbLoadBalancerDetails) SetHealthCheck(v *AwsElbLoadBalancerHealthCheck) *AwsElbLoadBalancerDetails {
- s.HealthCheck = v
- return s
+// String returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetInstances sets the Instances field's value.
-func (s *AwsElbLoadBalancerDetails) SetInstances(v []*AwsElbLoadBalancerInstance) *AwsElbLoadBalancerDetails {
- s.Instances = v
- return s
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) GoString() string {
+ return s.String()
}
-// SetListenerDescriptions sets the ListenerDescriptions field's value.
-func (s *AwsElbLoadBalancerDetails) SetListenerDescriptions(v []*AwsElbLoadBalancerListenerDescription) *AwsElbLoadBalancerDetails {
- s.ListenerDescriptions = v
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetName(v string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails {
+ s.Name = &v
return s
}
-// SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.
-func (s *AwsElbLoadBalancerDetails) SetLoadBalancerAttributes(v *AwsElbLoadBalancerAttributes) *AwsElbLoadBalancerDetails {
- s.LoadBalancerAttributes = v
+// SetValueFrom sets the ValueFrom field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails) SetValueFrom(v string) *AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails {
+ s.ValueFrom = &v
return s
}
-// SetLoadBalancerName sets the LoadBalancerName field's value.
-func (s *AwsElbLoadBalancerDetails) SetLoadBalancerName(v string) *AwsElbLoadBalancerDetails {
- s.LoadBalancerName = &v
- return s
-}
+// A mount point for the data volumes in the container.
+type AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails struct {
+ _ struct{} `type:"structure"`
-// SetPolicies sets the Policies field's value.
-func (s *AwsElbLoadBalancerDetails) SetPolicies(v *AwsElbLoadBalancerPolicies) *AwsElbLoadBalancerDetails {
- s.Policies = v
- return s
+ // The path on the container to mount the host volume at.
+ ContainerPath *string `type:"string"`
+
+ // Whether the container has read-only access to the volume.
+ ReadOnly *bool `type:"boolean"`
+
+ // The name of the volume to mount. Must match the name of a volume listed in
+ // VolumeDetails for the task definition.
+ SourceVolume *string `type:"string"`
}
-// SetScheme sets the Scheme field's value.
-func (s *AwsElbLoadBalancerDetails) SetScheme(v string) *AwsElbLoadBalancerDetails {
- s.Scheme = &v
- return s
+// String returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetSecurityGroups sets the SecurityGroups field's value.
-func (s *AwsElbLoadBalancerDetails) SetSecurityGroups(v []*string) *AwsElbLoadBalancerDetails {
- s.SecurityGroups = v
- return s
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) GoString() string {
+ return s.String()
}
-// SetSourceSecurityGroup sets the SourceSecurityGroup field's value.
-func (s *AwsElbLoadBalancerDetails) SetSourceSecurityGroup(v *AwsElbLoadBalancerSourceSecurityGroup) *AwsElbLoadBalancerDetails {
- s.SourceSecurityGroup = v
+// SetContainerPath sets the ContainerPath field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetContainerPath(v string) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails {
+ s.ContainerPath = &v
return s
}
-// SetSubnets sets the Subnets field's value.
-func (s *AwsElbLoadBalancerDetails) SetSubnets(v []*string) *AwsElbLoadBalancerDetails {
- s.Subnets = v
+// SetReadOnly sets the ReadOnly field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetReadOnly(v bool) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails {
+ s.ReadOnly = &v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsElbLoadBalancerDetails) SetVpcId(v string) *AwsElbLoadBalancerDetails {
- s.VpcId = &v
+// SetSourceVolume sets the SourceVolume field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails) SetSourceVolume(v string) *AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails {
+ s.SourceVolume = &v
return s
}
-// Contains information about the health checks that are conducted on the load
-// balancer.
-type AwsElbLoadBalancerHealthCheck struct {
+// A port mapping for the container.
+type AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails struct {
_ struct{} `type:"structure"`
- // The number of consecutive health check successes required before the instance
- // is moved to the Healthy state.
- HealthyThreshold *int64 `type:"integer"`
-
- // The approximate interval, in seconds, between health checks of an individual
- // instance.
- Interval *int64 `type:"integer"`
-
- // The instance that is being checked. The target specifies the protocol and
- // port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of
- // valid ports is 1 through 65535.
- //
- // For the HTTP and HTTPS protocols, the target also specifies the ping path.
- //
- // For the TCP protocol, the target is specified as TCP: .
- //
- // For the SSL protocol, the target is specified as SSL. .
- //
- // For the HTTP and HTTPS protocols, the target is specified as :/ .
- Target *string `type:"string"`
+ // The port number on the container that is bound to the user-specified or automatically
+ // assigned host port.
+ ContainerPort *int64 `type:"integer"`
- // The amount of time, in seconds, during which no response means a failed health
- // check.
- Timeout *int64 `type:"integer"`
+ // The port number on the container instance to reserve for the container.
+ HostPort *int64 `type:"integer"`
- // The number of consecutive health check failures that must occur before the
- // instance is moved to the Unhealthy state.
- UnhealthyThreshold *int64 `type:"integer"`
+ // The protocol used for the port mapping. The default is tcp.
+ Protocol *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerHealthCheck) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerHealthCheck) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) GoString() string {
return s.String()
}
-// SetHealthyThreshold sets the HealthyThreshold field's value.
-func (s *AwsElbLoadBalancerHealthCheck) SetHealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck {
- s.HealthyThreshold = &v
- return s
-}
-
-// SetInterval sets the Interval field's value.
-func (s *AwsElbLoadBalancerHealthCheck) SetInterval(v int64) *AwsElbLoadBalancerHealthCheck {
- s.Interval = &v
- return s
-}
-
-// SetTarget sets the Target field's value.
-func (s *AwsElbLoadBalancerHealthCheck) SetTarget(v string) *AwsElbLoadBalancerHealthCheck {
- s.Target = &v
+// SetContainerPort sets the ContainerPort field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetContainerPort(v int64) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails {
+ s.ContainerPort = &v
return s
}
-// SetTimeout sets the Timeout field's value.
-func (s *AwsElbLoadBalancerHealthCheck) SetTimeout(v int64) *AwsElbLoadBalancerHealthCheck {
- s.Timeout = &v
+// SetHostPort sets the HostPort field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetHostPort(v int64) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails {
+ s.HostPort = &v
return s
}
-// SetUnhealthyThreshold sets the UnhealthyThreshold field's value.
-func (s *AwsElbLoadBalancerHealthCheck) SetUnhealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck {
- s.UnhealthyThreshold = &v
+// SetProtocol sets the Protocol field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails) SetProtocol(v string) *AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails {
+ s.Protocol = &v
return s
}
-// Provides information about an EC2 instance for a load balancer.
-type AwsElbLoadBalancerInstance struct {
+// The private repository authentication credentials to use.
+type AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails struct {
_ struct{} `type:"structure"`
- // The instance identifier.
- InstanceId *string `type:"string"`
+ // The ARN of the secret that contains the private repository credentials.
+ CredentialsParameter *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerInstance) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerInstance) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) GoString() string {
return s.String()
}
-// SetInstanceId sets the InstanceId field's value.
-func (s *AwsElbLoadBalancerInstance) SetInstanceId(v string) *AwsElbLoadBalancerInstance {
- s.InstanceId = &v
+// SetCredentialsParameter sets the CredentialsParameter field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) SetCredentialsParameter(v string) *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails {
+ s.CredentialsParameter = &v
return s
}
-// Information about a load balancer listener.
-type AwsElbLoadBalancerListener struct {
+// A resource to assign to a container.
+type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails struct {
_ struct{} `type:"structure"`
- // The port on which the instance is listening.
- InstancePort *int64 `type:"integer"`
-
- // The protocol to use to route traffic to instances.
- //
- // Valid values: HTTP | HTTPS | TCP | SSL
- InstanceProtocol *string `type:"string"`
+ // The type of resource to assign to a container.
+ Type *string `type:"string"`
- // The port on which the load balancer is listening.
- //
- // On EC2-VPC, you can specify any port from the range 1-65535.
+ // The value for the specified resource type.
//
- // On EC2-Classic, you can specify any port from the following list: 25, 80,
- // 443, 465, 587, 1024-65535.
- LoadBalancerPort *int64 `type:"integer"`
-
- // The load balancer transport protocol to use for routing.
+ // For GPU, the value is the number of physical GPUs the Amazon ECS container
+ // agent reserves for the container.
//
- // Valid values: HTTP | HTTPS | TCP | SSL
- Protocol *string `type:"string"`
-
- // The ARN of the server certificate.
- SslCertificateId *string `type:"string"`
+ // For InferenceAccelerator, the value should match the DeviceName attribute
+ // of an entry in InferenceAccelerators.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerListener) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerListener) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) GoString() string {
return s.String()
}
-// SetInstancePort sets the InstancePort field's value.
-func (s *AwsElbLoadBalancerListener) SetInstancePort(v int64) *AwsElbLoadBalancerListener {
- s.InstancePort = &v
+// SetType sets the Type field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetType(v string) *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails {
+ s.Type = &v
return s
}
-// SetInstanceProtocol sets the InstanceProtocol field's value.
-func (s *AwsElbLoadBalancerListener) SetInstanceProtocol(v string) *AwsElbLoadBalancerListener {
- s.InstanceProtocol = &v
+// SetValue sets the Value field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails {
+ s.Value = &v
return s
}
-// SetLoadBalancerPort sets the LoadBalancerPort field's value.
-func (s *AwsElbLoadBalancerListener) SetLoadBalancerPort(v int64) *AwsElbLoadBalancerListener {
- s.LoadBalancerPort = &v
- return s
+// A secret to pass to the container.
+type AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the secret.
+ Name *string `type:"string"`
+
+ // The secret to expose to the container. The value is either the full ARN of
+ // the Secrets Manager secret or the full ARN of the parameter in the Systems
+ // Manager Parameter Store.
+ ValueFrom *string `type:"string"`
}
-// SetProtocol sets the Protocol field's value.
-func (s *AwsElbLoadBalancerListener) SetProtocol(v string) *AwsElbLoadBalancerListener {
- s.Protocol = &v
+// String returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) GoString() string {
+ return s.String()
+}
+
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetName(v string) *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails {
+ s.Name = &v
return s
}
-// SetSslCertificateId sets the SslCertificateId field's value.
-func (s *AwsElbLoadBalancerListener) SetSslCertificateId(v string) *AwsElbLoadBalancerListener {
- s.SslCertificateId = &v
+// SetValueFrom sets the ValueFrom field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails) SetValueFrom(v string) *AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails {
+ s.ValueFrom = &v
return s
}
-// Lists the policies that are enabled for a load balancer listener.
-type AwsElbLoadBalancerListenerDescription struct {
+// A namespaced kernel parameter to set in the container.
+type AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails struct {
_ struct{} `type:"structure"`
- // Information about the listener.
- Listener *AwsElbLoadBalancerListener `type:"structure"`
+ // The namespaced kernel parameter for which to set a value.
+ Namespace *string `type:"string"`
- // The policies enabled for the listener.
- PolicyNames []*string `type:"list"`
+ // The value of the parameter.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerListenerDescription) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerListenerDescription) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) GoString() string {
return s.String()
}
-// SetListener sets the Listener field's value.
-func (s *AwsElbLoadBalancerListenerDescription) SetListener(v *AwsElbLoadBalancerListener) *AwsElbLoadBalancerListenerDescription {
- s.Listener = v
+// SetNamespace sets the Namespace field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetNamespace(v string) *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails {
+ s.Namespace = &v
return s
}
-// SetPolicyNames sets the PolicyNames field's value.
-func (s *AwsElbLoadBalancerListenerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerListenerDescription {
- s.PolicyNames = v
+// SetValue sets the Value field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails) SetValue(v string) *AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails {
+ s.Value = &v
return s
}
-// Contains information about the policies for a load balancer.
-type AwsElbLoadBalancerPolicies struct {
+// A ulimit to set in the container.
+type AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails struct {
_ struct{} `type:"structure"`
- // The stickiness policies that are created using CreateAppCookieStickinessPolicy.
- AppCookieStickinessPolicies []*AwsElbAppCookieStickinessPolicy `type:"list"`
+ // The hard limit for the ulimit type.
+ HardLimit *int64 `type:"integer"`
- // The stickiness policies that are created using CreateLBCookieStickinessPolicy.
- LbCookieStickinessPolicies []*AwsElbLbCookieStickinessPolicy `type:"list"`
+ // The type of the ulimit.
+ Name *string `type:"string"`
- // The policies other than the stickiness policies.
- OtherPolicies []*string `type:"list"`
+ // The soft limit for the ulimit type.
+ SoftLimit *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerPolicies) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerPolicies) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) GoString() string {
return s.String()
}
-// SetAppCookieStickinessPolicies sets the AppCookieStickinessPolicies field's value.
-func (s *AwsElbLoadBalancerPolicies) SetAppCookieStickinessPolicies(v []*AwsElbAppCookieStickinessPolicy) *AwsElbLoadBalancerPolicies {
- s.AppCookieStickinessPolicies = v
+// SetHardLimit sets the HardLimit field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetHardLimit(v int64) *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails {
+ s.HardLimit = &v
return s
}
-// SetLbCookieStickinessPolicies sets the LbCookieStickinessPolicies field's value.
-func (s *AwsElbLoadBalancerPolicies) SetLbCookieStickinessPolicies(v []*AwsElbLbCookieStickinessPolicy) *AwsElbLoadBalancerPolicies {
- s.LbCookieStickinessPolicies = v
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetName(v string) *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails {
+ s.Name = &v
return s
}
-// SetOtherPolicies sets the OtherPolicies field's value.
-func (s *AwsElbLoadBalancerPolicies) SetOtherPolicies(v []*string) *AwsElbLoadBalancerPolicies {
- s.OtherPolicies = v
+// SetSoftLimit sets the SoftLimit field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails) SetSoftLimit(v int64) *AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails {
+ s.SoftLimit = &v
return s
}
-// Contains information about the security group for the load balancer.
-type AwsElbLoadBalancerSourceSecurityGroup struct {
+// A data volume to mount from another container.
+type AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails struct {
_ struct{} `type:"structure"`
- // The name of the security group.
- GroupName *string `type:"string"`
+ // Whether the container has read-only access to the volume.
+ ReadOnly *bool `type:"boolean"`
- // The owner of the security group.
- OwnerAlias *string `type:"string"`
+ // The name of another container within the same task definition from which
+ // to mount volumes.
+ SourceContainer *string `type:"string"`
}
// String returns the string representation
-func (s AwsElbLoadBalancerSourceSecurityGroup) String() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbLoadBalancerSourceSecurityGroup) GoString() string {
+func (s AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) GoString() string {
return s.String()
}
-// SetGroupName sets the GroupName field's value.
-func (s *AwsElbLoadBalancerSourceSecurityGroup) SetGroupName(v string) *AwsElbLoadBalancerSourceSecurityGroup {
- s.GroupName = &v
+// SetReadOnly sets the ReadOnly field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetReadOnly(v bool) *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails {
+ s.ReadOnly = &v
return s
}
-// SetOwnerAlias sets the OwnerAlias field's value.
-func (s *AwsElbLoadBalancerSourceSecurityGroup) SetOwnerAlias(v string) *AwsElbLoadBalancerSourceSecurityGroup {
- s.OwnerAlias = &v
+// SetSourceContainer sets the SourceContainer field's value.
+func (s *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails) SetSourceContainer(v string) *AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails {
+ s.SourceContainer = &v
return s
}
-// Information about a load balancer.
-type AwsElbv2LoadBalancerDetails struct {
+// details about a task definition. A task definition describes the container
+// and volume definitions of an Amazon Elastic Container Service task.
+type AwsEcsTaskDefinitionDetails struct {
_ struct{} `type:"structure"`
- // The Availability Zones for the load balancer.
- AvailabilityZones []*AvailabilityZone `type:"list"`
+ // The container definitions that describe the containers that make up the task.
+ ContainerDefinitions []*AwsEcsTaskDefinitionContainerDefinitionsDetails `type:"list"`
- // The ID of the Amazon Route 53 hosted zone associated with the load balancer.
- CanonicalHostedZoneId *string `type:"string"`
+ // The number of CPU units used by the task.
+ Cpu *string `type:"string"`
- // Indicates when the load balancer was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreatedTime *string `type:"string"`
+ // The ARN of the task execution role that grants the container agent permission
+ // to make API calls on behalf of the container user.
+ ExecutionRoleArn *string `type:"string"`
- // The public DNS name of the load balancer.
- DNSName *string `type:"string"`
+ // The name of a family that this task definition is registered to.
+ Family *string `type:"string"`
- // The type of IP addresses used by the subnets for your load balancer. The
- // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and
- // IPv6 addresses).
- IpAddressType *string `type:"string"`
+ // The Elastic Inference accelerators to use for the containers in the task.
+ InferenceAccelerators []*AwsEcsTaskDefinitionInferenceAcceleratorsDetails `type:"list"`
- // The nodes of an Internet-facing load balancer have public IP addresses.
- Scheme *string `type:"string"`
+ // The IPC resource namespace to use for the containers in the task.
+ IpcMode *string `type:"string"`
- // The IDs of the security groups for the load balancer.
- SecurityGroups []*string `type:"list"`
+ // The amount (in MiB) of memory used by the task.
+ Memory *string `type:"string"`
- // The state of the load balancer.
- State *LoadBalancerState `type:"structure"`
+ // The Docker networking mode to use for the containers in the task.
+ NetworkMode *string `type:"string"`
- // The type of load balancer.
- Type *string `type:"string"`
+ // The process namespace to use for the containers in the task.
+ PidMode *string `type:"string"`
- // The ID of the VPC for the load balancer.
- VpcId *string `type:"string"`
+ // The placement constraint objects to use for tasks.
+ PlacementConstraints []*AwsEcsTaskDefinitionPlacementConstraintsDetails `type:"list"`
+
+ // The configuration details for the App Mesh proxy.
+ ProxyConfiguration *AwsEcsTaskDefinitionProxyConfigurationDetails `type:"structure"`
+
+ // The task launch types that the task definition was validated against.
+ RequiresCompatibilities []*string `type:"list"`
+
+ // The short name or ARN of the IAM role that grants containers in the task
+ // permission to call AWS API operations on your behalf.
+ TaskRoleArn *string `type:"string"`
+
+ // The data volume definitions for the task.
+ Volumes []*AwsEcsTaskDefinitionVolumesDetails `type:"list"`
}
// String returns the string representation
-func (s AwsElbv2LoadBalancerDetails) String() string {
+func (s AwsEcsTaskDefinitionDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsElbv2LoadBalancerDetails) GoString() string {
+func (s AwsEcsTaskDefinitionDetails) GoString() string {
return s.String()
}
-// SetAvailabilityZones sets the AvailabilityZones field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetAvailabilityZones(v []*AvailabilityZone) *AwsElbv2LoadBalancerDetails {
- s.AvailabilityZones = v
+// SetContainerDefinitions sets the ContainerDefinitions field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetContainerDefinitions(v []*AwsEcsTaskDefinitionContainerDefinitionsDetails) *AwsEcsTaskDefinitionDetails {
+ s.ContainerDefinitions = v
return s
}
-// SetCanonicalHostedZoneId sets the CanonicalHostedZoneId field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId(v string) *AwsElbv2LoadBalancerDetails {
- s.CanonicalHostedZoneId = &v
+// SetCpu sets the Cpu field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetCpu(v string) *AwsEcsTaskDefinitionDetails {
+ s.Cpu = &v
return s
}
-// SetCreatedTime sets the CreatedTime field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetCreatedTime(v string) *AwsElbv2LoadBalancerDetails {
- s.CreatedTime = &v
+// SetExecutionRoleArn sets the ExecutionRoleArn field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetExecutionRoleArn(v string) *AwsEcsTaskDefinitionDetails {
+ s.ExecutionRoleArn = &v
return s
}
-// SetDNSName sets the DNSName field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetDNSName(v string) *AwsElbv2LoadBalancerDetails {
- s.DNSName = &v
+// SetFamily sets the Family field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetFamily(v string) *AwsEcsTaskDefinitionDetails {
+ s.Family = &v
return s
}
-// SetIpAddressType sets the IpAddressType field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetIpAddressType(v string) *AwsElbv2LoadBalancerDetails {
- s.IpAddressType = &v
+// SetInferenceAccelerators sets the InferenceAccelerators field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetInferenceAccelerators(v []*AwsEcsTaskDefinitionInferenceAcceleratorsDetails) *AwsEcsTaskDefinitionDetails {
+ s.InferenceAccelerators = v
return s
}
-// SetScheme sets the Scheme field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetScheme(v string) *AwsElbv2LoadBalancerDetails {
- s.Scheme = &v
+// SetIpcMode sets the IpcMode field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetIpcMode(v string) *AwsEcsTaskDefinitionDetails {
+ s.IpcMode = &v
return s
}
-// SetSecurityGroups sets the SecurityGroups field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetSecurityGroups(v []*string) *AwsElbv2LoadBalancerDetails {
- s.SecurityGroups = v
+// SetMemory sets the Memory field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetMemory(v string) *AwsEcsTaskDefinitionDetails {
+ s.Memory = &v
return s
}
-// SetState sets the State field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetState(v *LoadBalancerState) *AwsElbv2LoadBalancerDetails {
- s.State = v
+// SetNetworkMode sets the NetworkMode field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetNetworkMode(v string) *AwsEcsTaskDefinitionDetails {
+ s.NetworkMode = &v
return s
}
-// SetType sets the Type field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetType(v string) *AwsElbv2LoadBalancerDetails {
- s.Type = &v
+// SetPidMode sets the PidMode field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetPidMode(v string) *AwsEcsTaskDefinitionDetails {
+ s.PidMode = &v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsElbv2LoadBalancerDetails) SetVpcId(v string) *AwsElbv2LoadBalancerDetails {
- s.VpcId = &v
+// SetPlacementConstraints sets the PlacementConstraints field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetPlacementConstraints(v []*AwsEcsTaskDefinitionPlacementConstraintsDetails) *AwsEcsTaskDefinitionDetails {
+ s.PlacementConstraints = v
return s
}
-// IAM access key details related to a finding.
-type AwsIamAccessKeyDetails struct {
+// SetProxyConfiguration sets the ProxyConfiguration field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetProxyConfiguration(v *AwsEcsTaskDefinitionProxyConfigurationDetails) *AwsEcsTaskDefinitionDetails {
+ s.ProxyConfiguration = v
+ return s
+}
+
+// SetRequiresCompatibilities sets the RequiresCompatibilities field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetRequiresCompatibilities(v []*string) *AwsEcsTaskDefinitionDetails {
+ s.RequiresCompatibilities = v
+ return s
+}
+
+// SetTaskRoleArn sets the TaskRoleArn field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetTaskRoleArn(v string) *AwsEcsTaskDefinitionDetails {
+ s.TaskRoleArn = &v
+ return s
+}
+
+// SetVolumes sets the Volumes field's value.
+func (s *AwsEcsTaskDefinitionDetails) SetVolumes(v []*AwsEcsTaskDefinitionVolumesDetails) *AwsEcsTaskDefinitionDetails {
+ s.Volumes = v
+ return s
+}
+
+// An Elastic Inference accelerator to use for the containers in the task.
+type AwsEcsTaskDefinitionInferenceAcceleratorsDetails struct {
_ struct{} `type:"structure"`
- // The identifier of the access key.
- AccessKeyId *string `type:"string"`
+ // The Elastic Inference accelerator device name.
+ DeviceName *string `type:"string"`
- // The AWS account ID of the account for the key.
- AccountId *string `type:"string"`
+ // The Elastic Inference accelerator type to use.
+ DeviceType *string `type:"string"`
+}
- // Indicates when the IAM access key was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreatedAt *string `type:"string"`
+// String returns the string representation
+func (s AwsEcsTaskDefinitionInferenceAcceleratorsDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // The ID of the principal associated with an access key.
- PrincipalId *string `type:"string"`
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionInferenceAcceleratorsDetails) GoString() string {
+ return s.String()
+}
- // The name of the principal.
- PrincipalName *string `type:"string"`
+// SetDeviceName sets the DeviceName field's value.
+func (s *AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceName(v string) *AwsEcsTaskDefinitionInferenceAcceleratorsDetails {
+ s.DeviceName = &v
+ return s
+}
- // The type of principal associated with an access key.
- PrincipalType *string `type:"string"`
+// SetDeviceType sets the DeviceType field's value.
+func (s *AwsEcsTaskDefinitionInferenceAcceleratorsDetails) SetDeviceType(v string) *AwsEcsTaskDefinitionInferenceAcceleratorsDetails {
+ s.DeviceType = &v
+ return s
+}
- // Information about the session that the key was used for.
- SessionContext *AwsIamAccessKeySessionContext `type:"structure"`
+// A placement constraint object to use for tasks.
+type AwsEcsTaskDefinitionPlacementConstraintsDetails struct {
+ _ struct{} `type:"structure"`
- // The status of the IAM access key related to a finding.
- Status *string `type:"string" enum:"AwsIamAccessKeyStatus"`
+ // A cluster query language expression to apply to the constraint.
+ Expression *string `type:"string"`
- // The user associated with the IAM access key related to a finding.
- //
- // The UserName parameter has been replaced with the PrincipalName parameter
- // because access keys can also be assigned to principals that are not IAM users.
- //
- // Deprecated: This field is deprecated, use PrincipalName instead.
- UserName *string `deprecated:"true" type:"string"`
+ // The type of constraint.
+ Type *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamAccessKeyDetails) String() string {
+func (s AwsEcsTaskDefinitionPlacementConstraintsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamAccessKeyDetails) GoString() string {
+func (s AwsEcsTaskDefinitionPlacementConstraintsDetails) GoString() string {
return s.String()
}
-// SetAccessKeyId sets the AccessKeyId field's value.
-func (s *AwsIamAccessKeyDetails) SetAccessKeyId(v string) *AwsIamAccessKeyDetails {
- s.AccessKeyId = &v
+// SetExpression sets the Expression field's value.
+func (s *AwsEcsTaskDefinitionPlacementConstraintsDetails) SetExpression(v string) *AwsEcsTaskDefinitionPlacementConstraintsDetails {
+ s.Expression = &v
return s
}
-// SetAccountId sets the AccountId field's value.
-func (s *AwsIamAccessKeyDetails) SetAccountId(v string) *AwsIamAccessKeyDetails {
- s.AccountId = &v
+// SetType sets the Type field's value.
+func (s *AwsEcsTaskDefinitionPlacementConstraintsDetails) SetType(v string) *AwsEcsTaskDefinitionPlacementConstraintsDetails {
+ s.Type = &v
return s
}
-// SetCreatedAt sets the CreatedAt field's value.
-func (s *AwsIamAccessKeyDetails) SetCreatedAt(v string) *AwsIamAccessKeyDetails {
- s.CreatedAt = &v
- return s
-}
+// The configuration details for the App Mesh proxy.
+type AwsEcsTaskDefinitionProxyConfigurationDetails struct {
+ _ struct{} `type:"structure"`
-// SetPrincipalId sets the PrincipalId field's value.
-func (s *AwsIamAccessKeyDetails) SetPrincipalId(v string) *AwsIamAccessKeyDetails {
- s.PrincipalId = &v
- return s
+ // The name of the container that will serve as the App Mesh proxy.
+ ContainerName *string `type:"string"`
+
+ // The set of network configuration parameters to provide to the Container Network
+ // Interface (CNI) plugin, specified as key-value pairs.
+ ProxyConfigurationProperties []*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails `type:"list"`
+
+ // The proxy type.
+ Type *string `type:"string"`
}
-// SetPrincipalName sets the PrincipalName field's value.
-func (s *AwsIamAccessKeyDetails) SetPrincipalName(v string) *AwsIamAccessKeyDetails {
- s.PrincipalName = &v
- return s
+// String returns the string representation
+func (s AwsEcsTaskDefinitionProxyConfigurationDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetPrincipalType sets the PrincipalType field's value.
-func (s *AwsIamAccessKeyDetails) SetPrincipalType(v string) *AwsIamAccessKeyDetails {
- s.PrincipalType = &v
- return s
+// GoString returns the string representation
+func (s AwsEcsTaskDefinitionProxyConfigurationDetails) GoString() string {
+ return s.String()
}
-// SetSessionContext sets the SessionContext field's value.
-func (s *AwsIamAccessKeyDetails) SetSessionContext(v *AwsIamAccessKeySessionContext) *AwsIamAccessKeyDetails {
- s.SessionContext = v
+// SetContainerName sets the ContainerName field's value.
+func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetContainerName(v string) *AwsEcsTaskDefinitionProxyConfigurationDetails {
+ s.ContainerName = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsIamAccessKeyDetails) SetStatus(v string) *AwsIamAccessKeyDetails {
- s.Status = &v
+// SetProxyConfigurationProperties sets the ProxyConfigurationProperties field's value.
+func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetProxyConfigurationProperties(v []*AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) *AwsEcsTaskDefinitionProxyConfigurationDetails {
+ s.ProxyConfigurationProperties = v
return s
}
-// SetUserName sets the UserName field's value.
-func (s *AwsIamAccessKeyDetails) SetUserName(v string) *AwsIamAccessKeyDetails {
- s.UserName = &v
+// SetType sets the Type field's value.
+func (s *AwsEcsTaskDefinitionProxyConfigurationDetails) SetType(v string) *AwsEcsTaskDefinitionProxyConfigurationDetails {
+ s.Type = &v
return s
}
-// Provides information about the session that the key was used for.
-type AwsIamAccessKeySessionContext struct {
+// A network configuration parameter to provide to the Container Network Interface
+// (CNI) plugin.
+type AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails struct {
_ struct{} `type:"structure"`
- // Attributes of the session that the key was used for.
- Attributes *AwsIamAccessKeySessionContextAttributes `type:"structure"`
+ // The name of the property.
+ Name *string `type:"string"`
- // Information about the entity that created the session.
- SessionIssuer *AwsIamAccessKeySessionContextSessionIssuer `type:"structure"`
+ // The value of the property.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamAccessKeySessionContext) String() string {
+func (s AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamAccessKeySessionContext) GoString() string {
+func (s AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) GoString() string {
return s.String()
}
-// SetAttributes sets the Attributes field's value.
-func (s *AwsIamAccessKeySessionContext) SetAttributes(v *AwsIamAccessKeySessionContextAttributes) *AwsIamAccessKeySessionContext {
- s.Attributes = v
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetName(v string) *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails {
+ s.Name = &v
return s
}
-// SetSessionIssuer sets the SessionIssuer field's value.
-func (s *AwsIamAccessKeySessionContext) SetSessionIssuer(v *AwsIamAccessKeySessionContextSessionIssuer) *AwsIamAccessKeySessionContext {
- s.SessionIssuer = v
+// SetValue sets the Value field's value.
+func (s *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails) SetValue(v string) *AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails {
+ s.Value = &v
return s
}
-// Attributes of the session that the key was used for.
-type AwsIamAccessKeySessionContextAttributes struct {
+// A data volume to mount from another container.
+type AwsEcsTaskDefinitionVolumesDetails struct {
_ struct{} `type:"structure"`
- // Indicates when the session was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreationDate *string `type:"string"`
+ // Information about a Docker volume.
+ DockerVolumeConfiguration *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails `type:"structure"`
- // Indicates whether the session used multi-factor authentication (MFA).
- MfaAuthenticated *bool `type:"boolean"`
+ // Information about the Amazon Elastic File System file system that is used
+ // for task storage.
+ EfsVolumeConfiguration *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails `type:"structure"`
+
+ // Information about a bind mount host volume.
+ Host *AwsEcsTaskDefinitionVolumesHostDetails `type:"structure"`
+
+ // The name of the data volume.
+ Name *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamAccessKeySessionContextAttributes) String() string {
+func (s AwsEcsTaskDefinitionVolumesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamAccessKeySessionContextAttributes) GoString() string {
+func (s AwsEcsTaskDefinitionVolumesDetails) GoString() string {
return s.String()
}
-// SetCreationDate sets the CreationDate field's value.
-func (s *AwsIamAccessKeySessionContextAttributes) SetCreationDate(v string) *AwsIamAccessKeySessionContextAttributes {
- s.CreationDate = &v
+// SetDockerVolumeConfiguration sets the DockerVolumeConfiguration field's value.
+func (s *AwsEcsTaskDefinitionVolumesDetails) SetDockerVolumeConfiguration(v *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) *AwsEcsTaskDefinitionVolumesDetails {
+ s.DockerVolumeConfiguration = v
return s
}
-// SetMfaAuthenticated sets the MfaAuthenticated field's value.
-func (s *AwsIamAccessKeySessionContextAttributes) SetMfaAuthenticated(v bool) *AwsIamAccessKeySessionContextAttributes {
- s.MfaAuthenticated = &v
+// SetEfsVolumeConfiguration sets the EfsVolumeConfiguration field's value.
+func (s *AwsEcsTaskDefinitionVolumesDetails) SetEfsVolumeConfiguration(v *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) *AwsEcsTaskDefinitionVolumesDetails {
+ s.EfsVolumeConfiguration = v
return s
}
-// Information about the entity that created the session.
-type AwsIamAccessKeySessionContextSessionIssuer struct {
+// SetHost sets the Host field's value.
+func (s *AwsEcsTaskDefinitionVolumesDetails) SetHost(v *AwsEcsTaskDefinitionVolumesHostDetails) *AwsEcsTaskDefinitionVolumesDetails {
+ s.Host = v
+ return s
+}
+
+// SetName sets the Name field's value.
+func (s *AwsEcsTaskDefinitionVolumesDetails) SetName(v string) *AwsEcsTaskDefinitionVolumesDetails {
+ s.Name = &v
+ return s
+}
+
+// Information about a Docker volume.
+type AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails struct {
_ struct{} `type:"structure"`
- // The identifier of the AWS account that created the session.
- AccountId *string `type:"string"`
+ // Whether to create the Docker volume automatically if it does not already
+ // exist.
+ Autoprovision *bool `type:"boolean"`
- // The ARN of the session.
- Arn *string `type:"string"`
+ // The Docker volume driver to use.
+ Driver *string `type:"string"`
- // The principal ID of the principal (user, role, or group) that created the
- // session.
- PrincipalId *string `type:"string"`
+ // A map of Docker driver-specific options that are passed through.
+ DriverOpts map[string]*string `type:"map"`
- // The type of principal (user, role, or group) that created the session.
- Type *string `type:"string"`
+ // Custom metadata to add to the Docker volume.
+ Labels map[string]*string `type:"map"`
- // The name of the principal that created the session.
- UserName *string `type:"string"`
+ // The scope for the Docker volume that determines its lifecycle. Docker volumes
+ // that are scoped to a task are provisioned automatically when the task starts
+ // and destroyed when the task stops. Docker volumes that are shared persist
+ // after the task stops.
+ Scope *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamAccessKeySessionContextSessionIssuer) String() string {
+func (s AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamAccessKeySessionContextSessionIssuer) GoString() string {
+func (s AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) GoString() string {
return s.String()
}
-// SetAccountId sets the AccountId field's value.
-func (s *AwsIamAccessKeySessionContextSessionIssuer) SetAccountId(v string) *AwsIamAccessKeySessionContextSessionIssuer {
- s.AccountId = &v
+// SetAutoprovision sets the Autoprovision field's value.
+func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetAutoprovision(v bool) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
+ s.Autoprovision = &v
return s
}
-// SetArn sets the Arn field's value.
-func (s *AwsIamAccessKeySessionContextSessionIssuer) SetArn(v string) *AwsIamAccessKeySessionContextSessionIssuer {
- s.Arn = &v
+// SetDriver sets the Driver field's value.
+func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriver(v string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
+ s.Driver = &v
return s
}
-// SetPrincipalId sets the PrincipalId field's value.
-func (s *AwsIamAccessKeySessionContextSessionIssuer) SetPrincipalId(v string) *AwsIamAccessKeySessionContextSessionIssuer {
- s.PrincipalId = &v
+// SetDriverOpts sets the DriverOpts field's value.
+func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetDriverOpts(v map[string]*string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
+ s.DriverOpts = v
return s
}
-// SetType sets the Type field's value.
-func (s *AwsIamAccessKeySessionContextSessionIssuer) SetType(v string) *AwsIamAccessKeySessionContextSessionIssuer {
- s.Type = &v
+// SetLabels sets the Labels field's value.
+func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetLabels(v map[string]*string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
+ s.Labels = v
return s
}
-// SetUserName sets the UserName field's value.
-func (s *AwsIamAccessKeySessionContextSessionIssuer) SetUserName(v string) *AwsIamAccessKeySessionContextSessionIssuer {
- s.UserName = &v
+// SetScope sets the Scope field's value.
+func (s *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails) SetScope(v string) *AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
+ s.Scope = &v
return s
}
-// A managed policy that is attached to an IAM principal.
-type AwsIamAttachedManagedPolicy struct {
+type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails struct {
_ struct{} `type:"structure"`
- // The ARN of the policy.
- PolicyArn *string `type:"string"`
+ // The Amazon EFS access point identifier to use.
+ AccessPointId *string `type:"string"`
- // The name of the policy.
- PolicyName *string `type:"string"`
+ // Whether to use the Amazon ECS task IAM role defined in a task definition
+ // when mounting the Amazon EFS file system.
+ Iam *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamAttachedManagedPolicy) String() string {
+func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamAttachedManagedPolicy) GoString() string {
+func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) GoString() string {
return s.String()
}
-// SetPolicyArn sets the PolicyArn field's value.
-func (s *AwsIamAttachedManagedPolicy) SetPolicyArn(v string) *AwsIamAttachedManagedPolicy {
- s.PolicyArn = &v
+// SetAccessPointId sets the AccessPointId field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetAccessPointId(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails {
+ s.AccessPointId = &v
return s
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsIamAttachedManagedPolicy) SetPolicyName(v string) *AwsIamAttachedManagedPolicy {
- s.PolicyName = &v
+// SetIam sets the Iam field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) SetIam(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails {
+ s.Iam = &v
return s
}
-// Contains details about an IAM group.
-type AwsIamGroupDetails struct {
+// Information about the Amazon Elastic File System file system that is used
+// for task storage.
+type AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails struct {
_ struct{} `type:"structure"`
- // A list of the managed policies that are attached to the IAM group.
- AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
+ // The authorization configuration details for the Amazon EFS file system.
+ AuthorizationConfig *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails `type:"structure"`
- // Indicates when the IAM group was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
-
- // The identifier of the IAM group.
- GroupId *string `type:"string"`
+ // The Amazon EFS file system identifier to use.
+ FilesystemId *string `type:"string"`
- // The name of the IAM group.
- GroupName *string `type:"string"`
+ // The directory within the Amazon EFS file system to mount as the root directory
+ // inside the host.
+ RootDirectory *string `type:"string"`
- // The list of inline policies that are embedded in the group.
- GroupPolicyList []*AwsIamGroupPolicy `type:"list"`
+ // Whether to enable encryption for Amazon EFS data in transit between the Amazon
+ // ECS host and the Amazon EFS server.
+ TransitEncryption *string `type:"string"`
- // The path to the group.
- Path *string `type:"string"`
+ // The port to use when sending encrypted data between the Amazon ECS host and
+ // the Amazon EFS server.
+ TransitEncryptionPort *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsIamGroupDetails) String() string {
+func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamGroupDetails) GoString() string {
+func (s AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) GoString() string {
return s.String()
}
-// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
-func (s *AwsIamGroupDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamGroupDetails {
- s.AttachedManagedPolicies = v
- return s
-}
-
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamGroupDetails) SetCreateDate(v string) *AwsIamGroupDetails {
- s.CreateDate = &v
+// SetAuthorizationConfig sets the AuthorizationConfig field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetAuthorizationConfig(v *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
+ s.AuthorizationConfig = v
return s
}
-// SetGroupId sets the GroupId field's value.
-func (s *AwsIamGroupDetails) SetGroupId(v string) *AwsIamGroupDetails {
- s.GroupId = &v
+// SetFilesystemId sets the FilesystemId field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetFilesystemId(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
+ s.FilesystemId = &v
return s
}
-// SetGroupName sets the GroupName field's value.
-func (s *AwsIamGroupDetails) SetGroupName(v string) *AwsIamGroupDetails {
- s.GroupName = &v
+// SetRootDirectory sets the RootDirectory field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetRootDirectory(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
+ s.RootDirectory = &v
return s
}
-// SetGroupPolicyList sets the GroupPolicyList field's value.
-func (s *AwsIamGroupDetails) SetGroupPolicyList(v []*AwsIamGroupPolicy) *AwsIamGroupDetails {
- s.GroupPolicyList = v
+// SetTransitEncryption sets the TransitEncryption field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryption(v string) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
+ s.TransitEncryption = &v
return s
}
-// SetPath sets the Path field's value.
-func (s *AwsIamGroupDetails) SetPath(v string) *AwsIamGroupDetails {
- s.Path = &v
+// SetTransitEncryptionPort sets the TransitEncryptionPort field's value.
+func (s *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails) SetTransitEncryptionPort(v int64) *AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
+ s.TransitEncryptionPort = &v
return s
}
-// A managed policy that is attached to the IAM group.
-type AwsIamGroupPolicy struct {
+// Information about a bind mount host volume.
+type AwsEcsTaskDefinitionVolumesHostDetails struct {
_ struct{} `type:"structure"`
- // The name of the policy.
- PolicyName *string `type:"string"`
+ // The path on the host container instance that is presented to the container.
+ SourcePath *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamGroupPolicy) String() string {
+func (s AwsEcsTaskDefinitionVolumesHostDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamGroupPolicy) GoString() string {
+func (s AwsEcsTaskDefinitionVolumesHostDetails) GoString() string {
return s.String()
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsIamGroupPolicy) SetPolicyName(v string) *AwsIamGroupPolicy {
- s.PolicyName = &v
+// SetSourcePath sets the SourcePath field's value.
+func (s *AwsEcsTaskDefinitionVolumesHostDetails) SetSourcePath(v string) *AwsEcsTaskDefinitionVolumesHostDetails {
+ s.SourcePath = &v
return s
}
-// Information about an instance profile.
-type AwsIamInstanceProfile struct {
+// Contains details about an Elastic Beanstalk environment.
+type AwsElasticBeanstalkEnvironmentDetails struct {
_ struct{} `type:"structure"`
- // The ARN of the instance profile.
- Arn *string `type:"string"`
+ // The name of the application that is associated with the environment.
+ ApplicationName *string `type:"string"`
- // Indicates when the instance profile was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
+ // The URL to the CNAME for this environment.
+ Cname *string `type:"string"`
- // The identifier of the instance profile.
- InstanceProfileId *string `type:"string"`
+ // The creation date for this environment.
+ DateCreated *string `type:"string"`
- // The name of the instance profile.
- InstanceProfileName *string `type:"string"`
+ // The date when this environment was last modified.
+ DateUpdated *string `type:"string"`
- // The path to the instance profile.
- Path *string `type:"string"`
+ // A description of the environment.
+ Description *string `type:"string"`
- // The roles associated with the instance profile.
- Roles []*AwsIamInstanceProfileRole `type:"list"`
+ // For load-balanced, autoscaling environments, the URL to the load balancer.
+ // For single-instance environments, the IP address of the instance.
+ EndpointUrl *string `type:"string"`
+
+ // The ARN of the environment.
+ EnvironmentArn *string `type:"string"`
+
+ // The identifier of the environment.
+ EnvironmentId *string `type:"string"`
+
+ // Links to other environments in the same group.
+ EnvironmentLinks []*AwsElasticBeanstalkEnvironmentEnvironmentLink `type:"list"`
+
+ // The name of the environment.
+ EnvironmentName *string `type:"string"`
+
+ // The configuration setting for the environment.
+ OptionSettings []*AwsElasticBeanstalkEnvironmentOptionSetting `type:"list"`
+
+ // The ARN of the platform version for the environment.
+ PlatformArn *string `type:"string"`
+
+ // The name of the solution stack that is deployed with the environment.
+ SolutionStackName *string `type:"string"`
+
+ // The current operational status of the environment.
+ Status *string `type:"string"`
+
+ // The tier of the environment.
+ Tier *AwsElasticBeanstalkEnvironmentTier `type:"structure"`
+
+ // The application version of the environment.
+ VersionLabel *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamInstanceProfile) String() string {
+func (s AwsElasticBeanstalkEnvironmentDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamInstanceProfile) GoString() string {
+func (s AwsElasticBeanstalkEnvironmentDetails) GoString() string {
return s.String()
}
-// Validate inspects the fields of the type to determine if they are valid.
-func (s *AwsIamInstanceProfile) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "AwsIamInstanceProfile"}
- if s.Roles != nil {
- for i, v := range s.Roles {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Roles", i), err.(request.ErrInvalidParams))
- }
- }
- }
-
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
+// SetApplicationName sets the ApplicationName field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetApplicationName(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.ApplicationName = &v
+ return s
}
-// SetArn sets the Arn field's value.
-func (s *AwsIamInstanceProfile) SetArn(v string) *AwsIamInstanceProfile {
- s.Arn = &v
+// SetCname sets the Cname field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetCname(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.Cname = &v
return s
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamInstanceProfile) SetCreateDate(v string) *AwsIamInstanceProfile {
- s.CreateDate = &v
+// SetDateCreated sets the DateCreated field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateCreated(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.DateCreated = &v
return s
}
-// SetInstanceProfileId sets the InstanceProfileId field's value.
-func (s *AwsIamInstanceProfile) SetInstanceProfileId(v string) *AwsIamInstanceProfile {
- s.InstanceProfileId = &v
+// SetDateUpdated sets the DateUpdated field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetDateUpdated(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.DateUpdated = &v
return s
}
-// SetInstanceProfileName sets the InstanceProfileName field's value.
-func (s *AwsIamInstanceProfile) SetInstanceProfileName(v string) *AwsIamInstanceProfile {
- s.InstanceProfileName = &v
+// SetDescription sets the Description field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetDescription(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.Description = &v
return s
}
-// SetPath sets the Path field's value.
-func (s *AwsIamInstanceProfile) SetPath(v string) *AwsIamInstanceProfile {
- s.Path = &v
+// SetEndpointUrl sets the EndpointUrl field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetEndpointUrl(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.EndpointUrl = &v
return s
}
-// SetRoles sets the Roles field's value.
-func (s *AwsIamInstanceProfile) SetRoles(v []*AwsIamInstanceProfileRole) *AwsIamInstanceProfile {
- s.Roles = v
+// SetEnvironmentArn sets the EnvironmentArn field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentArn(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.EnvironmentArn = &v
return s
}
-// Information about a role associated with an instance profile.
-type AwsIamInstanceProfileRole struct {
- _ struct{} `type:"structure"`
-
- // The ARN of the role.
- Arn *string `type:"string"`
-
- // The policy that grants an entity permission to assume the role.
- AssumeRolePolicyDocument *string `min:"1" type:"string"`
-
- // Indicates when the role was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
-
- // The path to the role.
- Path *string `type:"string"`
-
- // The identifier of the role.
- RoleId *string `type:"string"`
-
- // The name of the role.
- RoleName *string `type:"string"`
+// SetEnvironmentId sets the EnvironmentId field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentId(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.EnvironmentId = &v
+ return s
}
-// String returns the string representation
-func (s AwsIamInstanceProfileRole) String() string {
- return awsutil.Prettify(s)
+// SetEnvironmentLinks sets the EnvironmentLinks field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentLinks(v []*AwsElasticBeanstalkEnvironmentEnvironmentLink) *AwsElasticBeanstalkEnvironmentDetails {
+ s.EnvironmentLinks = v
+ return s
}
-// GoString returns the string representation
-func (s AwsIamInstanceProfileRole) GoString() string {
- return s.String()
+// SetEnvironmentName sets the EnvironmentName field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.EnvironmentName = &v
+ return s
}
-// Validate inspects the fields of the type to determine if they are valid.
-func (s *AwsIamInstanceProfileRole) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "AwsIamInstanceProfileRole"}
- if s.AssumeRolePolicyDocument != nil && len(*s.AssumeRolePolicyDocument) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("AssumeRolePolicyDocument", 1))
- }
-
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
+// SetOptionSettings sets the OptionSettings field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetOptionSettings(v []*AwsElasticBeanstalkEnvironmentOptionSetting) *AwsElasticBeanstalkEnvironmentDetails {
+ s.OptionSettings = v
+ return s
}
-// SetArn sets the Arn field's value.
-func (s *AwsIamInstanceProfileRole) SetArn(v string) *AwsIamInstanceProfileRole {
- s.Arn = &v
+// SetPlatformArn sets the PlatformArn field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetPlatformArn(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.PlatformArn = &v
return s
}
-// SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.
-func (s *AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument(v string) *AwsIamInstanceProfileRole {
- s.AssumeRolePolicyDocument = &v
+// SetSolutionStackName sets the SolutionStackName field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetSolutionStackName(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.SolutionStackName = &v
return s
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamInstanceProfileRole) SetCreateDate(v string) *AwsIamInstanceProfileRole {
- s.CreateDate = &v
+// SetStatus sets the Status field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetStatus(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.Status = &v
return s
}
-// SetPath sets the Path field's value.
-func (s *AwsIamInstanceProfileRole) SetPath(v string) *AwsIamInstanceProfileRole {
- s.Path = &v
+// SetTier sets the Tier field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetTier(v *AwsElasticBeanstalkEnvironmentTier) *AwsElasticBeanstalkEnvironmentDetails {
+ s.Tier = v
return s
}
-// SetRoleId sets the RoleId field's value.
-func (s *AwsIamInstanceProfileRole) SetRoleId(v string) *AwsIamInstanceProfileRole {
- s.RoleId = &v
+// SetVersionLabel sets the VersionLabel field's value.
+func (s *AwsElasticBeanstalkEnvironmentDetails) SetVersionLabel(v string) *AwsElasticBeanstalkEnvironmentDetails {
+ s.VersionLabel = &v
return s
}
-// SetRoleName sets the RoleName field's value.
-func (s *AwsIamInstanceProfileRole) SetRoleName(v string) *AwsIamInstanceProfileRole {
- s.RoleName = &v
- return s
-}
-
-// Information about the policy used to set the permissions boundary for an
-// IAM principal.
-type AwsIamPermissionsBoundary struct {
+// Contains information about a link to another environment that is in the same
+// group.
+type AwsElasticBeanstalkEnvironmentEnvironmentLink struct {
_ struct{} `type:"structure"`
- // The ARN of the policy used to set the permissions boundary.
- PermissionsBoundaryArn *string `type:"string"`
+ // The name of the linked environment.
+ EnvironmentName *string `type:"string"`
- // The usage type for the permissions boundary.
- PermissionsBoundaryType *string `type:"string"`
+ // The name of the environment link.
+ LinkName *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamPermissionsBoundary) String() string {
+func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamPermissionsBoundary) GoString() string {
+func (s AwsElasticBeanstalkEnvironmentEnvironmentLink) GoString() string {
return s.String()
}
-// SetPermissionsBoundaryArn sets the PermissionsBoundaryArn field's value.
-func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryArn(v string) *AwsIamPermissionsBoundary {
- s.PermissionsBoundaryArn = &v
+// SetEnvironmentName sets the EnvironmentName field's value.
+func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetEnvironmentName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink {
+ s.EnvironmentName = &v
return s
}
-// SetPermissionsBoundaryType sets the PermissionsBoundaryType field's value.
-func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryType(v string) *AwsIamPermissionsBoundary {
- s.PermissionsBoundaryType = &v
+// SetLinkName sets the LinkName field's value.
+func (s *AwsElasticBeanstalkEnvironmentEnvironmentLink) SetLinkName(v string) *AwsElasticBeanstalkEnvironmentEnvironmentLink {
+ s.LinkName = &v
return s
}
-// Represents an IAM permissions policy.
-type AwsIamPolicyDetails struct {
+// A configuration option setting for the environment.
+type AwsElasticBeanstalkEnvironmentOptionSetting struct {
_ struct{} `type:"structure"`
- // The number of users, groups, and roles that the policy is attached to.
- AttachmentCount *int64 `type:"integer"`
-
- // When the policy was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
-
- // The identifier of the default version of the policy.
- DefaultVersionId *string `type:"string"`
-
- // A description of the policy.
- Description *string `type:"string"`
-
- // Whether the policy can be attached to a user, group, or role.
- IsAttachable *bool `type:"boolean"`
-
- // The path to the policy.
- Path *string `type:"string"`
-
- // The number of users and roles that use the policy to set the permissions
- // boundary.
- PermissionsBoundaryUsageCount *int64 `type:"integer"`
-
- // The unique identifier of the policy.
- PolicyId *string `type:"string"`
+ // The type of resource that the configuration option is associated with.
+ Namespace *string `type:"string"`
- // The name of the policy.
- PolicyName *string `type:"string"`
+ // The name of the option.
+ OptionName *string `type:"string"`
- // List of versions of the policy.
- PolicyVersionList []*AwsIamPolicyVersion `type:"list"`
+ // The name of the resource.
+ ResourceName *string `type:"string"`
- // When the policy was most recently updated.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- UpdateDate *string `type:"string"`
+ // The value of the configuration setting.
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamPolicyDetails) String() string {
+func (s AwsElasticBeanstalkEnvironmentOptionSetting) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamPolicyDetails) GoString() string {
+func (s AwsElasticBeanstalkEnvironmentOptionSetting) GoString() string {
return s.String()
}
-// SetAttachmentCount sets the AttachmentCount field's value.
-func (s *AwsIamPolicyDetails) SetAttachmentCount(v int64) *AwsIamPolicyDetails {
- s.AttachmentCount = &v
+// SetNamespace sets the Namespace field's value.
+func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetNamespace(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
+ s.Namespace = &v
return s
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamPolicyDetails) SetCreateDate(v string) *AwsIamPolicyDetails {
- s.CreateDate = &v
+// SetOptionName sets the OptionName field's value.
+func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetOptionName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
+ s.OptionName = &v
return s
}
-// SetDefaultVersionId sets the DefaultVersionId field's value.
-func (s *AwsIamPolicyDetails) SetDefaultVersionId(v string) *AwsIamPolicyDetails {
- s.DefaultVersionId = &v
+// SetResourceName sets the ResourceName field's value.
+func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetResourceName(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
+ s.ResourceName = &v
return s
}
-// SetDescription sets the Description field's value.
-func (s *AwsIamPolicyDetails) SetDescription(v string) *AwsIamPolicyDetails {
- s.Description = &v
+// SetValue sets the Value field's value.
+func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetValue(v string) *AwsElasticBeanstalkEnvironmentOptionSetting {
+ s.Value = &v
return s
}
-// SetIsAttachable sets the IsAttachable field's value.
-func (s *AwsIamPolicyDetails) SetIsAttachable(v bool) *AwsIamPolicyDetails {
- s.IsAttachable = &v
- return s
-}
+// Contains information about the tier of the environment.
+type AwsElasticBeanstalkEnvironmentTier struct {
+ _ struct{} `type:"structure"`
-// SetPath sets the Path field's value.
-func (s *AwsIamPolicyDetails) SetPath(v string) *AwsIamPolicyDetails {
- s.Path = &v
- return s
+ // The name of the environment tier.
+ Name *string `type:"string"`
+
+ // The type of environment tier.
+ Type *string `type:"string"`
+
+ // The version of the environment tier.
+ Version *string `type:"string"`
}
-// SetPermissionsBoundaryUsageCount sets the PermissionsBoundaryUsageCount field's value.
-func (s *AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount(v int64) *AwsIamPolicyDetails {
- s.PermissionsBoundaryUsageCount = &v
- return s
+// String returns the string representation
+func (s AwsElasticBeanstalkEnvironmentTier) String() string {
+ return awsutil.Prettify(s)
}
-// SetPolicyId sets the PolicyId field's value.
-func (s *AwsIamPolicyDetails) SetPolicyId(v string) *AwsIamPolicyDetails {
- s.PolicyId = &v
- return s
+// GoString returns the string representation
+func (s AwsElasticBeanstalkEnvironmentTier) GoString() string {
+ return s.String()
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsIamPolicyDetails) SetPolicyName(v string) *AwsIamPolicyDetails {
- s.PolicyName = &v
+// SetName sets the Name field's value.
+func (s *AwsElasticBeanstalkEnvironmentTier) SetName(v string) *AwsElasticBeanstalkEnvironmentTier {
+ s.Name = &v
return s
}
-// SetPolicyVersionList sets the PolicyVersionList field's value.
-func (s *AwsIamPolicyDetails) SetPolicyVersionList(v []*AwsIamPolicyVersion) *AwsIamPolicyDetails {
- s.PolicyVersionList = v
+// SetType sets the Type field's value.
+func (s *AwsElasticBeanstalkEnvironmentTier) SetType(v string) *AwsElasticBeanstalkEnvironmentTier {
+ s.Type = &v
return s
}
-// SetUpdateDate sets the UpdateDate field's value.
-func (s *AwsIamPolicyDetails) SetUpdateDate(v string) *AwsIamPolicyDetails {
- s.UpdateDate = &v
+// SetVersion sets the Version field's value.
+func (s *AwsElasticBeanstalkEnvironmentTier) SetVersion(v string) *AwsElasticBeanstalkEnvironmentTier {
+ s.Version = &v
return s
}
-// A version of an IAM policy.
-type AwsIamPolicyVersion struct {
+// Information about an Elasticsearch domain.
+type AwsElasticsearchDomainDetails struct {
_ struct{} `type:"structure"`
- // Indicates when the version was created.
+ // IAM policy document specifying the access policies for the new Amazon ES
+ // domain.
+ AccessPolicies *string `type:"string"`
+
+ // Additional options for the domain endpoint.
+ DomainEndpointOptions *AwsElasticsearchDomainDomainEndpointOptions `type:"structure"`
+
+ // Unique identifier for an Amazon ES domain.
+ DomainId *string `type:"string"`
+
+ // Name of an Amazon ES domain.
//
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
+ // Domain names are unique across all domains owned by the same account within
+ // an AWS Region.
+ //
+ // Domain names must start with a lowercase letter and must be between 3 and
+ // 28 characters.
+ //
+ // Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
+ DomainName *string `type:"string"`
- // Whether the version is the default version.
- IsDefaultVersion *bool `type:"boolean"`
+ // Elasticsearch version.
+ ElasticsearchVersion *string `type:"string"`
- // The identifier of the policy version.
- VersionId *string `type:"string"`
+ // Details about the configuration for encryption at rest.
+ EncryptionAtRestOptions *AwsElasticsearchDomainEncryptionAtRestOptions `type:"structure"`
+
+ // Domain-specific endpoint used to submit index, search, and data upload requests
+ // to an Amazon ES domain.
+ //
+ // The endpoint is a service URL.
+ Endpoint *string `type:"string"`
+
+ // The key-value pair that exists if the Amazon ES domain uses VPC endpoints.
+ Endpoints map[string]*string `type:"map"`
+
+ // Configures the CloudWatch Logs to publish for the Elasticsearch domain.
+ LogPublishingOptions *AwsElasticsearchDomainLogPublishingOptions `type:"structure"`
+
+ // Details about the configuration for node-to-node encryption.
+ NodeToNodeEncryptionOptions *AwsElasticsearchDomainNodeToNodeEncryptionOptions `type:"structure"`
+
+ // Information about the status of a domain relative to the latest service software.
+ ServiceSoftwareOptions *AwsElasticsearchDomainServiceSoftwareOptions `type:"structure"`
+
+ // Information that Amazon ES derives based on VPCOptions for the domain.
+ VPCOptions *AwsElasticsearchDomainVPCOptions `type:"structure"`
}
// String returns the string representation
-func (s AwsIamPolicyVersion) String() string {
+func (s AwsElasticsearchDomainDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamPolicyVersion) GoString() string {
+func (s AwsElasticsearchDomainDetails) GoString() string {
return s.String()
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamPolicyVersion) SetCreateDate(v string) *AwsIamPolicyVersion {
- s.CreateDate = &v
+// SetAccessPolicies sets the AccessPolicies field's value.
+func (s *AwsElasticsearchDomainDetails) SetAccessPolicies(v string) *AwsElasticsearchDomainDetails {
+ s.AccessPolicies = &v
return s
}
-// SetIsDefaultVersion sets the IsDefaultVersion field's value.
-func (s *AwsIamPolicyVersion) SetIsDefaultVersion(v bool) *AwsIamPolicyVersion {
- s.IsDefaultVersion = &v
+// SetDomainEndpointOptions sets the DomainEndpointOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetDomainEndpointOptions(v *AwsElasticsearchDomainDomainEndpointOptions) *AwsElasticsearchDomainDetails {
+ s.DomainEndpointOptions = v
return s
}
-// SetVersionId sets the VersionId field's value.
-func (s *AwsIamPolicyVersion) SetVersionId(v string) *AwsIamPolicyVersion {
- s.VersionId = &v
+// SetDomainId sets the DomainId field's value.
+func (s *AwsElasticsearchDomainDetails) SetDomainId(v string) *AwsElasticsearchDomainDetails {
+ s.DomainId = &v
return s
}
-// Contains information about an IAM role, including all of the role's policies.
-type AwsIamRoleDetails struct {
- _ struct{} `type:"structure"`
+// SetDomainName sets the DomainName field's value.
+func (s *AwsElasticsearchDomainDetails) SetDomainName(v string) *AwsElasticsearchDomainDetails {
+ s.DomainName = &v
+ return s
+}
- // The trust policy that grants permission to assume the role.
- AssumeRolePolicyDocument *string `min:"1" type:"string"`
+// SetElasticsearchVersion sets the ElasticsearchVersion field's value.
+func (s *AwsElasticsearchDomainDetails) SetElasticsearchVersion(v string) *AwsElasticsearchDomainDetails {
+ s.ElasticsearchVersion = &v
+ return s
+}
- // The list of the managed policies that are attached to the role.
- AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
+// SetEncryptionAtRestOptions sets the EncryptionAtRestOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetEncryptionAtRestOptions(v *AwsElasticsearchDomainEncryptionAtRestOptions) *AwsElasticsearchDomainDetails {
+ s.EncryptionAtRestOptions = v
+ return s
+}
- // Indicates when the role was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
+// SetEndpoint sets the Endpoint field's value.
+func (s *AwsElasticsearchDomainDetails) SetEndpoint(v string) *AwsElasticsearchDomainDetails {
+ s.Endpoint = &v
+ return s
+}
- // The list of instance profiles that contain this role.
- InstanceProfileList []*AwsIamInstanceProfile `type:"list"`
+// SetEndpoints sets the Endpoints field's value.
+func (s *AwsElasticsearchDomainDetails) SetEndpoints(v map[string]*string) *AwsElasticsearchDomainDetails {
+ s.Endpoints = v
+ return s
+}
- // The maximum session duration (in seconds) that you want to set for the specified
- // role.
- MaxSessionDuration *int64 `type:"integer"`
+// SetLogPublishingOptions sets the LogPublishingOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetLogPublishingOptions(v *AwsElasticsearchDomainLogPublishingOptions) *AwsElasticsearchDomainDetails {
+ s.LogPublishingOptions = v
+ return s
+}
- // The path to the role.
- Path *string `type:"string"`
+// SetNodeToNodeEncryptionOptions sets the NodeToNodeEncryptionOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetNodeToNodeEncryptionOptions(v *AwsElasticsearchDomainNodeToNodeEncryptionOptions) *AwsElasticsearchDomainDetails {
+ s.NodeToNodeEncryptionOptions = v
+ return s
+}
- // Information about the policy used to set the permissions boundary for an
- // IAM principal.
- PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`
+// SetServiceSoftwareOptions sets the ServiceSoftwareOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetServiceSoftwareOptions(v *AwsElasticsearchDomainServiceSoftwareOptions) *AwsElasticsearchDomainDetails {
+ s.ServiceSoftwareOptions = v
+ return s
+}
- // The stable and unique string identifying the role.
- RoleId *string `type:"string"`
+// SetVPCOptions sets the VPCOptions field's value.
+func (s *AwsElasticsearchDomainDetails) SetVPCOptions(v *AwsElasticsearchDomainVPCOptions) *AwsElasticsearchDomainDetails {
+ s.VPCOptions = v
+ return s
+}
- // The friendly name that identifies the role.
- RoleName *string `type:"string"`
+// Additional options for the domain endpoint, such as whether to require HTTPS
+// for all traffic.
+type AwsElasticsearchDomainDomainEndpointOptions struct {
+ _ struct{} `type:"structure"`
- // The list of inline policies that are embedded in the role.
- RolePolicyList []*AwsIamRolePolicy `type:"list"`
+ // Whether to require that all traffic to the domain arrive over HTTPS.
+ EnforceHTTPS *bool `type:"boolean"`
+
+ // The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch
+ // domain.
+ //
+ // Valid values:
+ //
+ // * Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
+ //
+ // * Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
+ TLSSecurityPolicy *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamRoleDetails) String() string {
+func (s AwsElasticsearchDomainDomainEndpointOptions) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamRoleDetails) GoString() string {
+func (s AwsElasticsearchDomainDomainEndpointOptions) GoString() string {
return s.String()
}
-// Validate inspects the fields of the type to determine if they are valid.
-func (s *AwsIamRoleDetails) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "AwsIamRoleDetails"}
- if s.AssumeRolePolicyDocument != nil && len(*s.AssumeRolePolicyDocument) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("AssumeRolePolicyDocument", 1))
- }
- if s.InstanceProfileList != nil {
- for i, v := range s.InstanceProfileList {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "InstanceProfileList", i), err.(request.ErrInvalidParams))
- }
- }
- }
-
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
+// SetEnforceHTTPS sets the EnforceHTTPS field's value.
+func (s *AwsElasticsearchDomainDomainEndpointOptions) SetEnforceHTTPS(v bool) *AwsElasticsearchDomainDomainEndpointOptions {
+ s.EnforceHTTPS = &v
+ return s
}
-// SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.
-func (s *AwsIamRoleDetails) SetAssumeRolePolicyDocument(v string) *AwsIamRoleDetails {
- s.AssumeRolePolicyDocument = &v
+// SetTLSSecurityPolicy sets the TLSSecurityPolicy field's value.
+func (s *AwsElasticsearchDomainDomainEndpointOptions) SetTLSSecurityPolicy(v string) *AwsElasticsearchDomainDomainEndpointOptions {
+ s.TLSSecurityPolicy = &v
return s
}
-// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
-func (s *AwsIamRoleDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamRoleDetails {
- s.AttachedManagedPolicies = v
- return s
+// Details about the configuration for encryption at rest.
+type AwsElasticsearchDomainEncryptionAtRestOptions struct {
+ _ struct{} `type:"structure"`
+
+ // Whether encryption at rest is enabled.
+ Enabled *bool `type:"boolean"`
+
+ // The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
+ KmsKeyId *string `type:"string"`
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamRoleDetails) SetCreateDate(v string) *AwsIamRoleDetails {
- s.CreateDate = &v
- return s
+// String returns the string representation
+func (s AwsElasticsearchDomainEncryptionAtRestOptions) String() string {
+ return awsutil.Prettify(s)
}
-// SetInstanceProfileList sets the InstanceProfileList field's value.
-func (s *AwsIamRoleDetails) SetInstanceProfileList(v []*AwsIamInstanceProfile) *AwsIamRoleDetails {
- s.InstanceProfileList = v
- return s
+// GoString returns the string representation
+func (s AwsElasticsearchDomainEncryptionAtRestOptions) GoString() string {
+ return s.String()
}
-// SetMaxSessionDuration sets the MaxSessionDuration field's value.
-func (s *AwsIamRoleDetails) SetMaxSessionDuration(v int64) *AwsIamRoleDetails {
- s.MaxSessionDuration = &v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetEnabled(v bool) *AwsElasticsearchDomainEncryptionAtRestOptions {
+ s.Enabled = &v
return s
}
-// SetPath sets the Path field's value.
-func (s *AwsIamRoleDetails) SetPath(v string) *AwsIamRoleDetails {
- s.Path = &v
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsElasticsearchDomainEncryptionAtRestOptions) SetKmsKeyId(v string) *AwsElasticsearchDomainEncryptionAtRestOptions {
+ s.KmsKeyId = &v
return s
}
-// SetPermissionsBoundary sets the PermissionsBoundary field's value.
-func (s *AwsIamRoleDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamRoleDetails {
- s.PermissionsBoundary = v
+// configures the CloudWatch Logs to publish for the Elasticsearch domain.
+type AwsElasticsearchDomainLogPublishingOptions struct {
+ _ struct{} `type:"structure"`
+
+ // Configures the Elasticsearch index logs publishing.
+ IndexSlowLogs *AwsElasticsearchDomainLogPublishingOptionsLogConfig `type:"structure"`
+
+ // Configures the Elasticsearch search slow log publishing.
+ SearchSlowLogs *AwsElasticsearchDomainLogPublishingOptionsLogConfig `type:"structure"`
+}
+
+// String returns the string representation
+func (s AwsElasticsearchDomainLogPublishingOptions) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsElasticsearchDomainLogPublishingOptions) GoString() string {
+ return s.String()
+}
+
+// SetIndexSlowLogs sets the IndexSlowLogs field's value.
+func (s *AwsElasticsearchDomainLogPublishingOptions) SetIndexSlowLogs(v *AwsElasticsearchDomainLogPublishingOptionsLogConfig) *AwsElasticsearchDomainLogPublishingOptions {
+ s.IndexSlowLogs = v
return s
}
-// SetRoleId sets the RoleId field's value.
-func (s *AwsIamRoleDetails) SetRoleId(v string) *AwsIamRoleDetails {
- s.RoleId = &v
+// SetSearchSlowLogs sets the SearchSlowLogs field's value.
+func (s *AwsElasticsearchDomainLogPublishingOptions) SetSearchSlowLogs(v *AwsElasticsearchDomainLogPublishingOptionsLogConfig) *AwsElasticsearchDomainLogPublishingOptions {
+ s.SearchSlowLogs = v
return s
}
-// SetRoleName sets the RoleName field's value.
-func (s *AwsIamRoleDetails) SetRoleName(v string) *AwsIamRoleDetails {
- s.RoleName = &v
+// The log configuration.
+type AwsElasticsearchDomainLogPublishingOptionsLogConfig struct {
+ _ struct{} `type:"structure"`
+
+ // The ARN of the CloudWatch Logs group to publish the logs to.
+ CloudWatchLogsLogGroupArn *string `type:"string"`
+
+ // Whether the log publishing is enabled.
+ Enabled *bool `type:"boolean"`
+}
+
+// String returns the string representation
+func (s AwsElasticsearchDomainLogPublishingOptionsLogConfig) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsElasticsearchDomainLogPublishingOptionsLogConfig) GoString() string {
+ return s.String()
+}
+
+// SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.
+func (s *AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetCloudWatchLogsLogGroupArn(v string) *AwsElasticsearchDomainLogPublishingOptionsLogConfig {
+ s.CloudWatchLogsLogGroupArn = &v
return s
}
-// SetRolePolicyList sets the RolePolicyList field's value.
-func (s *AwsIamRoleDetails) SetRolePolicyList(v []*AwsIamRolePolicy) *AwsIamRoleDetails {
- s.RolePolicyList = v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElasticsearchDomainLogPublishingOptionsLogConfig) SetEnabled(v bool) *AwsElasticsearchDomainLogPublishingOptionsLogConfig {
+ s.Enabled = &v
return s
}
-// An inline policy that is embedded in the role.
-type AwsIamRolePolicy struct {
+// Details about the configuration for node-to-node encryption.
+type AwsElasticsearchDomainNodeToNodeEncryptionOptions struct {
_ struct{} `type:"structure"`
- // The name of the policy.
- PolicyName *string `type:"string"`
+ // Whether node-to-node encryption is enabled.
+ Enabled *bool `type:"boolean"`
}
// String returns the string representation
-func (s AwsIamRolePolicy) String() string {
+func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamRolePolicy) GoString() string {
+func (s AwsElasticsearchDomainNodeToNodeEncryptionOptions) GoString() string {
return s.String()
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsIamRolePolicy) SetPolicyName(v string) *AwsIamRolePolicy {
- s.PolicyName = &v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElasticsearchDomainNodeToNodeEncryptionOptions) SetEnabled(v bool) *AwsElasticsearchDomainNodeToNodeEncryptionOptions {
+ s.Enabled = &v
return s
}
-// Information about an IAM user.
-type AwsIamUserDetails struct {
+// Information about the state of the domain relative to the latest service
+// software.
+type AwsElasticsearchDomainServiceSoftwareOptions struct {
_ struct{} `type:"structure"`
- // A list of the managed policies that are attached to the user.
- AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
-
- // Indicates when the user was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreateDate *string `type:"string"`
+ // The epoch time when the deployment window closes for required updates. After
+ // this time, Amazon Elasticsearch Service schedules the software upgrade automatically.
+ AutomatedUpdateDate *string `type:"string"`
- // A list of IAM groups that the user belongs to.
- GroupList []*string `type:"list"`
+ // Whether a request to update the domain can be canceled.
+ Cancellable *bool `type:"boolean"`
- // The path to the user.
- Path *string `type:"string"`
+ // The version of the service software that is currently installed on the domain.
+ CurrentVersion *string `type:"string"`
- // The permissions boundary for the user.
- PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`
+ // A more detailed description of the service software status.
+ Description *string `type:"string"`
- // The unique identifier for the user.
- UserId *string `type:"string"`
+ // The most recent version of the service software.
+ NewVersion *string `type:"string"`
- // The name of the user.
- UserName *string `type:"string"`
+ // Whether a service software update is available for the domain.
+ UpdateAvailable *bool `type:"boolean"`
- // The list of inline policies that are embedded in the user.
- UserPolicyList []*AwsIamUserPolicy `type:"list"`
+ // The status of the service software update.
+ UpdateStatus *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamUserDetails) String() string {
+func (s AwsElasticsearchDomainServiceSoftwareOptions) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamUserDetails) GoString() string {
+func (s AwsElasticsearchDomainServiceSoftwareOptions) GoString() string {
return s.String()
}
-// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
-func (s *AwsIamUserDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamUserDetails {
- s.AttachedManagedPolicies = v
+// SetAutomatedUpdateDate sets the AutomatedUpdateDate field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetAutomatedUpdateDate(v string) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.AutomatedUpdateDate = &v
return s
}
-// SetCreateDate sets the CreateDate field's value.
-func (s *AwsIamUserDetails) SetCreateDate(v string) *AwsIamUserDetails {
- s.CreateDate = &v
+// SetCancellable sets the Cancellable field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetCancellable(v bool) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.Cancellable = &v
return s
}
-// SetGroupList sets the GroupList field's value.
-func (s *AwsIamUserDetails) SetGroupList(v []*string) *AwsIamUserDetails {
- s.GroupList = v
+// SetCurrentVersion sets the CurrentVersion field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetCurrentVersion(v string) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.CurrentVersion = &v
return s
}
-// SetPath sets the Path field's value.
-func (s *AwsIamUserDetails) SetPath(v string) *AwsIamUserDetails {
- s.Path = &v
+// SetDescription sets the Description field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetDescription(v string) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.Description = &v
return s
}
-// SetPermissionsBoundary sets the PermissionsBoundary field's value.
-func (s *AwsIamUserDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamUserDetails {
- s.PermissionsBoundary = v
+// SetNewVersion sets the NewVersion field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetNewVersion(v string) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.NewVersion = &v
return s
}
-// SetUserId sets the UserId field's value.
-func (s *AwsIamUserDetails) SetUserId(v string) *AwsIamUserDetails {
- s.UserId = &v
+// SetUpdateAvailable sets the UpdateAvailable field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateAvailable(v bool) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.UpdateAvailable = &v
return s
}
-// SetUserName sets the UserName field's value.
-func (s *AwsIamUserDetails) SetUserName(v string) *AwsIamUserDetails {
- s.UserName = &v
+// SetUpdateStatus sets the UpdateStatus field's value.
+func (s *AwsElasticsearchDomainServiceSoftwareOptions) SetUpdateStatus(v string) *AwsElasticsearchDomainServiceSoftwareOptions {
+ s.UpdateStatus = &v
return s
}
-// SetUserPolicyList sets the UserPolicyList field's value.
-func (s *AwsIamUserDetails) SetUserPolicyList(v []*AwsIamUserPolicy) *AwsIamUserDetails {
- s.UserPolicyList = v
- return s
-}
-
-// Information about an inline policy that is embedded in the user.
-type AwsIamUserPolicy struct {
+// Information that Amazon ES derives based on VPCOptions for the domain.
+type AwsElasticsearchDomainVPCOptions struct {
_ struct{} `type:"structure"`
- // The name of the policy.
- PolicyName *string `type:"string"`
+ // The list of Availability Zones associated with the VPC subnets.
+ AvailabilityZones []*string `type:"list"`
+
+ // The list of security group IDs associated with the VPC endpoints for the
+ // domain.
+ SecurityGroupIds []*string `type:"list"`
+
+ // A list of subnet IDs associated with the VPC endpoints for the domain.
+ SubnetIds []*string `type:"list"`
+
+ // ID for the VPC.
+ VPCId *string `type:"string"`
}
// String returns the string representation
-func (s AwsIamUserPolicy) String() string {
+func (s AwsElasticsearchDomainVPCOptions) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsIamUserPolicy) GoString() string {
+func (s AwsElasticsearchDomainVPCOptions) GoString() string {
return s.String()
}
-// SetPolicyName sets the PolicyName field's value.
-func (s *AwsIamUserPolicy) SetPolicyName(v string) *AwsIamUserPolicy {
- s.PolicyName = &v
+// SetAvailabilityZones sets the AvailabilityZones field's value.
+func (s *AwsElasticsearchDomainVPCOptions) SetAvailabilityZones(v []*string) *AwsElasticsearchDomainVPCOptions {
+ s.AvailabilityZones = v
return s
}
-// Contains metadata about a customer master key (CMK).
-type AwsKmsKeyDetails struct {
- _ struct{} `type:"structure"`
-
- // The twelve-digit account ID of the AWS account that owns the CMK.
- AWSAccountId *string `type:"string"`
-
- // Indicates when the CMK was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreationDate *float64 `type:"double"`
+// SetSecurityGroupIds sets the SecurityGroupIds field's value.
+func (s *AwsElasticsearchDomainVPCOptions) SetSecurityGroupIds(v []*string) *AwsElasticsearchDomainVPCOptions {
+ s.SecurityGroupIds = v
+ return s
+}
- // A description of the key.
- Description *string `type:"string"`
+// SetSubnetIds sets the SubnetIds field's value.
+func (s *AwsElasticsearchDomainVPCOptions) SetSubnetIds(v []*string) *AwsElasticsearchDomainVPCOptions {
+ s.SubnetIds = v
+ return s
+}
- // The globally unique identifier for the CMK.
- KeyId *string `type:"string"`
+// SetVPCId sets the VPCId field's value.
+func (s *AwsElasticsearchDomainVPCOptions) SetVPCId(v string) *AwsElasticsearchDomainVPCOptions {
+ s.VPCId = &v
+ return s
+}
- // The manager of the CMK. CMKs in your AWS account are either customer managed
- // or AWS managed.
- KeyManager *string `type:"string"`
+// Contains information about a stickiness policy that was created using CreateAppCookieStickinessPolicy.
+type AwsElbAppCookieStickinessPolicy struct {
+ _ struct{} `type:"structure"`
- // The state of the CMK.
- KeyState *string `type:"string"`
+ // The name of the application cookie used for stickiness.
+ CookieName *string `type:"string"`
- // The source of the CMK's key material.
- //
- // When this value is AWS_KMS, AWS KMS created the key material.
- //
- // When this value is EXTERNAL, the key material was imported from your existing
- // key management infrastructure or the CMK lacks key material.
- //
- // When this value is AWS_CLOUDHSM, the key material was created in the AWS
- // CloudHSM cluster associated with a custom key store.
- Origin *string `type:"string"`
+ // The mnemonic name for the policy being created. The name must be unique within
+ // the set of policies for the load balancer.
+ PolicyName *string `type:"string"`
}
// String returns the string representation
-func (s AwsKmsKeyDetails) String() string {
+func (s AwsElbAppCookieStickinessPolicy) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsKmsKeyDetails) GoString() string {
+func (s AwsElbAppCookieStickinessPolicy) GoString() string {
return s.String()
}
-// SetAWSAccountId sets the AWSAccountId field's value.
-func (s *AwsKmsKeyDetails) SetAWSAccountId(v string) *AwsKmsKeyDetails {
- s.AWSAccountId = &v
+// SetCookieName sets the CookieName field's value.
+func (s *AwsElbAppCookieStickinessPolicy) SetCookieName(v string) *AwsElbAppCookieStickinessPolicy {
+ s.CookieName = &v
return s
}
-// SetCreationDate sets the CreationDate field's value.
-func (s *AwsKmsKeyDetails) SetCreationDate(v float64) *AwsKmsKeyDetails {
- s.CreationDate = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsElbAppCookieStickinessPolicy) SetPolicyName(v string) *AwsElbAppCookieStickinessPolicy {
+ s.PolicyName = &v
return s
}
-// SetDescription sets the Description field's value.
-func (s *AwsKmsKeyDetails) SetDescription(v string) *AwsKmsKeyDetails {
- s.Description = &v
- return s
+// Contains information about a stickiness policy that was created using CreateLBCookieStickinessPolicy.
+type AwsElbLbCookieStickinessPolicy struct {
+ _ struct{} `type:"structure"`
+
+ // The amount of time, in seconds, after which the cookie is considered stale.
+ // If an expiration period is not specified, the stickiness session lasts for
+ // the duration of the browser session.
+ CookieExpirationPeriod *int64 `type:"long"`
+
+ // The name of the policy. The name must be unique within the set of policies
+ // for the load balancer.
+ PolicyName *string `type:"string"`
}
-// SetKeyId sets the KeyId field's value.
-func (s *AwsKmsKeyDetails) SetKeyId(v string) *AwsKmsKeyDetails {
- s.KeyId = &v
- return s
+// String returns the string representation
+func (s AwsElbLbCookieStickinessPolicy) String() string {
+ return awsutil.Prettify(s)
}
-// SetKeyManager sets the KeyManager field's value.
-func (s *AwsKmsKeyDetails) SetKeyManager(v string) *AwsKmsKeyDetails {
- s.KeyManager = &v
- return s
+// GoString returns the string representation
+func (s AwsElbLbCookieStickinessPolicy) GoString() string {
+ return s.String()
}
-// SetKeyState sets the KeyState field's value.
-func (s *AwsKmsKeyDetails) SetKeyState(v string) *AwsKmsKeyDetails {
- s.KeyState = &v
+// SetCookieExpirationPeriod sets the CookieExpirationPeriod field's value.
+func (s *AwsElbLbCookieStickinessPolicy) SetCookieExpirationPeriod(v int64) *AwsElbLbCookieStickinessPolicy {
+ s.CookieExpirationPeriod = &v
return s
}
-// SetOrigin sets the Origin field's value.
-func (s *AwsKmsKeyDetails) SetOrigin(v string) *AwsKmsKeyDetails {
- s.Origin = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsElbLbCookieStickinessPolicy) SetPolicyName(v string) *AwsElbLbCookieStickinessPolicy {
+ s.PolicyName = &v
return s
}
-// The code for the Lambda function. You can specify either an object in Amazon
-// S3, or upload a deployment package directly.
-type AwsLambdaFunctionCode struct {
+// Contains information about the access log configuration for the load balancer.
+type AwsElbLoadBalancerAccessLog struct {
_ struct{} `type:"structure"`
- // An Amazon S3 bucket in the same AWS Region as your function. The bucket can
- // be in a different AWS account.
- S3Bucket *string `type:"string"`
+ // The interval in minutes for publishing the access logs.
+ //
+ // You can publish access logs either every 5 minutes or every 60 minutes.
+ EmitInterval *int64 `type:"integer"`
- // The Amazon S3 key of the deployment package.
- S3Key *string `type:"string"`
+ // Indicates whether access logs are enabled for the load balancer.
+ Enabled *bool `type:"boolean"`
- // For versioned objects, the version of the deployment package object to use.
- S3ObjectVersion *string `type:"string"`
+ // The name of the S3 bucket where the access logs are stored.
+ S3BucketName *string `type:"string"`
- // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI
- // clients handle the encoding for you.
- ZipFile *string `type:"string"`
+ // The logical hierarchy that was created for the S3 bucket.
+ //
+ // If a prefix is not provided, the log is placed at the root level of the bucket.
+ S3BucketPrefix *string `type:"string"`
}
// String returns the string representation
-func (s AwsLambdaFunctionCode) String() string {
+func (s AwsElbLoadBalancerAccessLog) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionCode) GoString() string {
+func (s AwsElbLoadBalancerAccessLog) GoString() string {
return s.String()
}
-// SetS3Bucket sets the S3Bucket field's value.
-func (s *AwsLambdaFunctionCode) SetS3Bucket(v string) *AwsLambdaFunctionCode {
- s.S3Bucket = &v
+// SetEmitInterval sets the EmitInterval field's value.
+func (s *AwsElbLoadBalancerAccessLog) SetEmitInterval(v int64) *AwsElbLoadBalancerAccessLog {
+ s.EmitInterval = &v
return s
}
-// SetS3Key sets the S3Key field's value.
-func (s *AwsLambdaFunctionCode) SetS3Key(v string) *AwsLambdaFunctionCode {
- s.S3Key = &v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElbLoadBalancerAccessLog) SetEnabled(v bool) *AwsElbLoadBalancerAccessLog {
+ s.Enabled = &v
return s
}
-// SetS3ObjectVersion sets the S3ObjectVersion field's value.
-func (s *AwsLambdaFunctionCode) SetS3ObjectVersion(v string) *AwsLambdaFunctionCode {
- s.S3ObjectVersion = &v
+// SetS3BucketName sets the S3BucketName field's value.
+func (s *AwsElbLoadBalancerAccessLog) SetS3BucketName(v string) *AwsElbLoadBalancerAccessLog {
+ s.S3BucketName = &v
return s
}
-// SetZipFile sets the ZipFile field's value.
-func (s *AwsLambdaFunctionCode) SetZipFile(v string) *AwsLambdaFunctionCode {
- s.ZipFile = &v
+// SetS3BucketPrefix sets the S3BucketPrefix field's value.
+func (s *AwsElbLoadBalancerAccessLog) SetS3BucketPrefix(v string) *AwsElbLoadBalancerAccessLog {
+ s.S3BucketPrefix = &v
return s
}
-// The dead-letter queue for failed asynchronous invocations.
-type AwsLambdaFunctionDeadLetterConfig struct {
+// Contains attributes for the load balancer.
+type AwsElbLoadBalancerAttributes struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
- TargetArn *string `type:"string"`
+ // Information about the access log configuration for the load balancer.
+ //
+ // If the access log is enabled, the load balancer captures detailed information
+ // about all requests. It delivers the information to a specified S3 bucket.
+ AccessLog *AwsElbLoadBalancerAccessLog `type:"structure"`
+
+ // Information about the connection draining configuration for the load balancer.
+ //
+ // If connection draining is enabled, the load balancer allows existing requests
+ // to complete before it shifts traffic away from a deregistered or unhealthy
+ // instance.
+ ConnectionDraining *AwsElbLoadBalancerConnectionDraining `type:"structure"`
+
+ // Connection settings for the load balancer.
+ //
+ // If an idle timeout is configured, the load balancer allows connections to
+ // remain idle for the specified duration. When a connection is idle, no data
+ // is sent over the connection.
+ ConnectionSettings *AwsElbLoadBalancerConnectionSettings `type:"structure"`
+
+ // Cross-zone load balancing settings for the load balancer.
+ //
+ // If cross-zone load balancing is enabled, the load balancer routes the request
+ // traffic evenly across all instances regardless of the Availability Zones.
+ CrossZoneLoadBalancing *AwsElbLoadBalancerCrossZoneLoadBalancing `type:"structure"`
}
// String returns the string representation
-func (s AwsLambdaFunctionDeadLetterConfig) String() string {
+func (s AwsElbLoadBalancerAttributes) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionDeadLetterConfig) GoString() string {
+func (s AwsElbLoadBalancerAttributes) GoString() string {
return s.String()
}
-// SetTargetArn sets the TargetArn field's value.
-func (s *AwsLambdaFunctionDeadLetterConfig) SetTargetArn(v string) *AwsLambdaFunctionDeadLetterConfig {
- s.TargetArn = &v
+// SetAccessLog sets the AccessLog field's value.
+func (s *AwsElbLoadBalancerAttributes) SetAccessLog(v *AwsElbLoadBalancerAccessLog) *AwsElbLoadBalancerAttributes {
+ s.AccessLog = v
return s
}
-// Details about a function's configuration.
-type AwsLambdaFunctionDetails struct {
- _ struct{} `type:"structure"`
+// SetConnectionDraining sets the ConnectionDraining field's value.
+func (s *AwsElbLoadBalancerAttributes) SetConnectionDraining(v *AwsElbLoadBalancerConnectionDraining) *AwsElbLoadBalancerAttributes {
+ s.ConnectionDraining = v
+ return s
+}
- // An AwsLambdaFunctionCode object.
- Code *AwsLambdaFunctionCode `type:"structure"`
+// SetConnectionSettings sets the ConnectionSettings field's value.
+func (s *AwsElbLoadBalancerAttributes) SetConnectionSettings(v *AwsElbLoadBalancerConnectionSettings) *AwsElbLoadBalancerAttributes {
+ s.ConnectionSettings = v
+ return s
+}
- // The SHA256 hash of the function's deployment package.
- CodeSha256 *string `type:"string"`
-
- // The function's dead letter queue.
- DeadLetterConfig *AwsLambdaFunctionDeadLetterConfig `type:"structure"`
-
- // The function's environment variables.
- Environment *AwsLambdaFunctionEnvironment `type:"structure"`
-
- // The name of the function.
- FunctionName *string `type:"string"`
-
- // The function that Lambda calls to begin executing your function.
- Handler *string `type:"string"`
-
- // The KMS key that's used to encrypt the function's environment variables.
- // This key is only returned if you've configured a customer managed CMK.
- KmsKeyArn *string `type:"string"`
-
- // Indicates when the function was last updated.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- LastModified *string `type:"string"`
-
- // The function's layers.
- Layers []*AwsLambdaFunctionLayer `type:"list"`
-
- // For Lambda@Edge functions, the ARN of the master function.
- MasterArn *string `type:"string"`
-
- // The memory that's allocated to the function.
- MemorySize *int64 `type:"integer"`
-
- // The latest updated revision of the function or alias.
- RevisionId *string `type:"string"`
-
- // The function's execution role.
- Role *string `type:"string"`
-
- // The runtime environment for the Lambda function.
- Runtime *string `type:"string"`
-
- // The amount of time that Lambda allows a function to run before stopping it.
- Timeout *int64 `type:"integer"`
+// SetCrossZoneLoadBalancing sets the CrossZoneLoadBalancing field's value.
+func (s *AwsElbLoadBalancerAttributes) SetCrossZoneLoadBalancing(v *AwsElbLoadBalancerCrossZoneLoadBalancing) *AwsElbLoadBalancerAttributes {
+ s.CrossZoneLoadBalancing = v
+ return s
+}
- // The function's AWS X-Ray tracing configuration.
- TracingConfig *AwsLambdaFunctionTracingConfig `type:"structure"`
+// Provides information about the configuration of an EC2 instance for the load
+// balancer.
+type AwsElbLoadBalancerBackendServerDescription struct {
+ _ struct{} `type:"structure"`
- // The version of the Lambda function.
- Version *string `type:"string"`
+ // The port on which the EC2 instance is listening.
+ InstancePort *int64 `type:"integer"`
- // The function's networking configuration.
- VpcConfig *AwsLambdaFunctionVpcConfig `type:"structure"`
+ // The names of the policies that are enabled for the EC2 instance.
+ PolicyNames []*string `type:"list"`
}
// String returns the string representation
-func (s AwsLambdaFunctionDetails) String() string {
+func (s AwsElbLoadBalancerBackendServerDescription) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionDetails) GoString() string {
+func (s AwsElbLoadBalancerBackendServerDescription) GoString() string {
return s.String()
}
-// SetCode sets the Code field's value.
-func (s *AwsLambdaFunctionDetails) SetCode(v *AwsLambdaFunctionCode) *AwsLambdaFunctionDetails {
- s.Code = v
- return s
-}
-
-// SetCodeSha256 sets the CodeSha256 field's value.
-func (s *AwsLambdaFunctionDetails) SetCodeSha256(v string) *AwsLambdaFunctionDetails {
- s.CodeSha256 = &v
- return s
-}
-
-// SetDeadLetterConfig sets the DeadLetterConfig field's value.
-func (s *AwsLambdaFunctionDetails) SetDeadLetterConfig(v *AwsLambdaFunctionDeadLetterConfig) *AwsLambdaFunctionDetails {
- s.DeadLetterConfig = v
- return s
-}
-
-// SetEnvironment sets the Environment field's value.
-func (s *AwsLambdaFunctionDetails) SetEnvironment(v *AwsLambdaFunctionEnvironment) *AwsLambdaFunctionDetails {
- s.Environment = v
- return s
-}
-
-// SetFunctionName sets the FunctionName field's value.
-func (s *AwsLambdaFunctionDetails) SetFunctionName(v string) *AwsLambdaFunctionDetails {
- s.FunctionName = &v
- return s
-}
-
-// SetHandler sets the Handler field's value.
-func (s *AwsLambdaFunctionDetails) SetHandler(v string) *AwsLambdaFunctionDetails {
- s.Handler = &v
- return s
-}
-
-// SetKmsKeyArn sets the KmsKeyArn field's value.
-func (s *AwsLambdaFunctionDetails) SetKmsKeyArn(v string) *AwsLambdaFunctionDetails {
- s.KmsKeyArn = &v
+// SetInstancePort sets the InstancePort field's value.
+func (s *AwsElbLoadBalancerBackendServerDescription) SetInstancePort(v int64) *AwsElbLoadBalancerBackendServerDescription {
+ s.InstancePort = &v
return s
}
-// SetLastModified sets the LastModified field's value.
-func (s *AwsLambdaFunctionDetails) SetLastModified(v string) *AwsLambdaFunctionDetails {
- s.LastModified = &v
+// SetPolicyNames sets the PolicyNames field's value.
+func (s *AwsElbLoadBalancerBackendServerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerBackendServerDescription {
+ s.PolicyNames = v
return s
}
-// SetLayers sets the Layers field's value.
-func (s *AwsLambdaFunctionDetails) SetLayers(v []*AwsLambdaFunctionLayer) *AwsLambdaFunctionDetails {
- s.Layers = v
- return s
-}
+// Contains information about the connection draining configuration for the
+// load balancer.
+type AwsElbLoadBalancerConnectionDraining struct {
+ _ struct{} `type:"structure"`
-// SetMasterArn sets the MasterArn field's value.
-func (s *AwsLambdaFunctionDetails) SetMasterArn(v string) *AwsLambdaFunctionDetails {
- s.MasterArn = &v
- return s
-}
+ // Indicates whether connection draining is enabled for the load balancer.
+ Enabled *bool `type:"boolean"`
-// SetMemorySize sets the MemorySize field's value.
-func (s *AwsLambdaFunctionDetails) SetMemorySize(v int64) *AwsLambdaFunctionDetails {
- s.MemorySize = &v
- return s
+ // The maximum time, in seconds, to keep the existing connections open before
+ // deregistering the instances.
+ Timeout *int64 `type:"integer"`
}
-// SetRevisionId sets the RevisionId field's value.
-func (s *AwsLambdaFunctionDetails) SetRevisionId(v string) *AwsLambdaFunctionDetails {
- s.RevisionId = &v
- return s
+// String returns the string representation
+func (s AwsElbLoadBalancerConnectionDraining) String() string {
+ return awsutil.Prettify(s)
}
-// SetRole sets the Role field's value.
-func (s *AwsLambdaFunctionDetails) SetRole(v string) *AwsLambdaFunctionDetails {
- s.Role = &v
- return s
+// GoString returns the string representation
+func (s AwsElbLoadBalancerConnectionDraining) GoString() string {
+ return s.String()
}
-// SetRuntime sets the Runtime field's value.
-func (s *AwsLambdaFunctionDetails) SetRuntime(v string) *AwsLambdaFunctionDetails {
- s.Runtime = &v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElbLoadBalancerConnectionDraining) SetEnabled(v bool) *AwsElbLoadBalancerConnectionDraining {
+ s.Enabled = &v
return s
}
// SetTimeout sets the Timeout field's value.
-func (s *AwsLambdaFunctionDetails) SetTimeout(v int64) *AwsLambdaFunctionDetails {
+func (s *AwsElbLoadBalancerConnectionDraining) SetTimeout(v int64) *AwsElbLoadBalancerConnectionDraining {
s.Timeout = &v
return s
}
-// SetTracingConfig sets the TracingConfig field's value.
-func (s *AwsLambdaFunctionDetails) SetTracingConfig(v *AwsLambdaFunctionTracingConfig) *AwsLambdaFunctionDetails {
- s.TracingConfig = v
- return s
-}
-
-// SetVersion sets the Version field's value.
-func (s *AwsLambdaFunctionDetails) SetVersion(v string) *AwsLambdaFunctionDetails {
- s.Version = &v
- return s
-}
-
-// SetVpcConfig sets the VpcConfig field's value.
-func (s *AwsLambdaFunctionDetails) SetVpcConfig(v *AwsLambdaFunctionVpcConfig) *AwsLambdaFunctionDetails {
- s.VpcConfig = v
- return s
-}
-
-// A function's environment variable settings.
-type AwsLambdaFunctionEnvironment struct {
+// Contains connection settings for the load balancer.
+type AwsElbLoadBalancerConnectionSettings struct {
_ struct{} `type:"structure"`
- // An AwsLambdaFunctionEnvironmentError object.
- Error *AwsLambdaFunctionEnvironmentError `type:"structure"`
-
- // Environment variable key-value pairs.
- Variables map[string]*string `type:"map"`
+ // The time, in seconds, that the connection can be idle (no data is sent over
+ // the connection) before it is closed by the load balancer.
+ IdleTimeout *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsLambdaFunctionEnvironment) String() string {
+func (s AwsElbLoadBalancerConnectionSettings) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionEnvironment) GoString() string {
+func (s AwsElbLoadBalancerConnectionSettings) GoString() string {
return s.String()
}
-// SetError sets the Error field's value.
-func (s *AwsLambdaFunctionEnvironment) SetError(v *AwsLambdaFunctionEnvironmentError) *AwsLambdaFunctionEnvironment {
- s.Error = v
- return s
-}
-
-// SetVariables sets the Variables field's value.
-func (s *AwsLambdaFunctionEnvironment) SetVariables(v map[string]*string) *AwsLambdaFunctionEnvironment {
- s.Variables = v
+// SetIdleTimeout sets the IdleTimeout field's value.
+func (s *AwsElbLoadBalancerConnectionSettings) SetIdleTimeout(v int64) *AwsElbLoadBalancerConnectionSettings {
+ s.IdleTimeout = &v
return s
}
-// Error messages for environment variables that couldn't be applied.
-type AwsLambdaFunctionEnvironmentError struct {
+// Contains cross-zone load balancing settings for the load balancer.
+type AwsElbLoadBalancerCrossZoneLoadBalancing struct {
_ struct{} `type:"structure"`
- // The error code.
- ErrorCode *string `type:"string"`
-
- // The error message.
- Message *string `type:"string"`
+ // Indicates whether cross-zone load balancing is enabled for the load balancer.
+ Enabled *bool `type:"boolean"`
}
// String returns the string representation
-func (s AwsLambdaFunctionEnvironmentError) String() string {
+func (s AwsElbLoadBalancerCrossZoneLoadBalancing) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionEnvironmentError) GoString() string {
+func (s AwsElbLoadBalancerCrossZoneLoadBalancing) GoString() string {
return s.String()
}
-// SetErrorCode sets the ErrorCode field's value.
-func (s *AwsLambdaFunctionEnvironmentError) SetErrorCode(v string) *AwsLambdaFunctionEnvironmentError {
- s.ErrorCode = &v
- return s
-}
-
-// SetMessage sets the Message field's value.
-func (s *AwsLambdaFunctionEnvironmentError) SetMessage(v string) *AwsLambdaFunctionEnvironmentError {
- s.Message = &v
+// SetEnabled sets the Enabled field's value.
+func (s *AwsElbLoadBalancerCrossZoneLoadBalancing) SetEnabled(v bool) *AwsElbLoadBalancerCrossZoneLoadBalancing {
+ s.Enabled = &v
return s
}
-// An AWS Lambda layer.
-type AwsLambdaFunctionLayer struct {
+// Contains details about a Classic Load Balancer.
+type AwsElbLoadBalancerDetails struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of the function layer.
- Arn *string `type:"string"`
+ // The list of Availability Zones for the load balancer.
+ AvailabilityZones []*string `type:"list"`
- // The size of the layer archive in bytes.
- CodeSize *int64 `type:"integer"`
-}
+ // Information about the configuration of the EC2 instances.
+ BackendServerDescriptions []*AwsElbLoadBalancerBackendServerDescription `type:"list"`
-// String returns the string representation
-func (s AwsLambdaFunctionLayer) String() string {
- return awsutil.Prettify(s)
-}
+ // The name of the Amazon Route 53 hosted zone for the load balancer.
+ CanonicalHostedZoneName *string `type:"string"`
-// GoString returns the string representation
-func (s AwsLambdaFunctionLayer) GoString() string {
- return s.String()
-}
+ // The ID of the Amazon Route 53 hosted zone for the load balancer.
+ CanonicalHostedZoneNameID *string `type:"string"`
-// SetArn sets the Arn field's value.
-func (s *AwsLambdaFunctionLayer) SetArn(v string) *AwsLambdaFunctionLayer {
- s.Arn = &v
- return s
-}
+ // Indicates when the load balancer was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreatedTime *string `type:"string"`
-// SetCodeSize sets the CodeSize field's value.
-func (s *AwsLambdaFunctionLayer) SetCodeSize(v int64) *AwsLambdaFunctionLayer {
- s.CodeSize = &v
- return s
-}
+ // The DNS name of the load balancer.
+ DnsName *string `type:"string"`
-// The function's AWS X-Ray tracing configuration.
-type AwsLambdaFunctionTracingConfig struct {
- _ struct{} `type:"structure"`
+ // Information about the health checks that are conducted on the load balancer.
+ HealthCheck *AwsElbLoadBalancerHealthCheck `type:"structure"`
- // The tracing mode.
- Mode *string `type:"string"`
+ // List of EC2 instances for the load balancer.
+ Instances []*AwsElbLoadBalancerInstance `type:"list"`
+
+ // The policies that are enabled for the load balancer listeners.
+ ListenerDescriptions []*AwsElbLoadBalancerListenerDescription `type:"list"`
+
+ // The attributes for a load balancer.
+ LoadBalancerAttributes *AwsElbLoadBalancerAttributes `type:"structure"`
+
+ // The name of the load balancer.
+ LoadBalancerName *string `type:"string"`
+
+ // The policies for a load balancer.
+ Policies *AwsElbLoadBalancerPolicies `type:"structure"`
+
+ // The type of load balancer. Only provided if the load balancer is in a VPC.
+ //
+ // If Scheme is internet-facing, the load balancer has a public DNS name that
+ // resolves to a public IP address.
+ //
+ // If Scheme is internal, the load balancer has a public DNS name that resolves
+ // to a private IP address.
+ Scheme *string `type:"string"`
+
+ // The security groups for the load balancer. Only provided if the load balancer
+ // is in a VPC.
+ SecurityGroups []*string `type:"list"`
+
+ // Information about the security group for the load balancer. This is the security
+ // group that is used for inbound rules.
+ SourceSecurityGroup *AwsElbLoadBalancerSourceSecurityGroup `type:"structure"`
+
+ // The list of subnet identifiers for the load balancer.
+ Subnets []*string `type:"list"`
+
+ // The identifier of the VPC for the load balancer.
+ VpcId *string `type:"string"`
}
// String returns the string representation
-func (s AwsLambdaFunctionTracingConfig) String() string {
+func (s AwsElbLoadBalancerDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsLambdaFunctionTracingConfig) GoString() string {
+func (s AwsElbLoadBalancerDetails) GoString() string {
return s.String()
}
-// SetMode sets the Mode field's value.
-func (s *AwsLambdaFunctionTracingConfig) SetMode(v string) *AwsLambdaFunctionTracingConfig {
- s.Mode = &v
+// SetAvailabilityZones sets the AvailabilityZones field's value.
+func (s *AwsElbLoadBalancerDetails) SetAvailabilityZones(v []*string) *AwsElbLoadBalancerDetails {
+ s.AvailabilityZones = v
return s
}
-// The VPC security groups and subnets that are attached to a Lambda function.
-// For more information, see VPC Settings.
-type AwsLambdaFunctionVpcConfig struct {
- _ struct{} `type:"structure"`
-
- // A list of VPC security groups IDs.
- SecurityGroupIds []*string `type:"list"`
-
- // A list of VPC subnet IDs.
- SubnetIds []*string `type:"list"`
+// SetBackendServerDescriptions sets the BackendServerDescriptions field's value.
+func (s *AwsElbLoadBalancerDetails) SetBackendServerDescriptions(v []*AwsElbLoadBalancerBackendServerDescription) *AwsElbLoadBalancerDetails {
+ s.BackendServerDescriptions = v
+ return s
+}
- // The ID of the VPC.
- VpcId *string `type:"string"`
+// SetCanonicalHostedZoneName sets the CanonicalHostedZoneName field's value.
+func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneName(v string) *AwsElbLoadBalancerDetails {
+ s.CanonicalHostedZoneName = &v
+ return s
}
-// String returns the string representation
-func (s AwsLambdaFunctionVpcConfig) String() string {
- return awsutil.Prettify(s)
+// SetCanonicalHostedZoneNameID sets the CanonicalHostedZoneNameID field's value.
+func (s *AwsElbLoadBalancerDetails) SetCanonicalHostedZoneNameID(v string) *AwsElbLoadBalancerDetails {
+ s.CanonicalHostedZoneNameID = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsLambdaFunctionVpcConfig) GoString() string {
- return s.String()
+// SetCreatedTime sets the CreatedTime field's value.
+func (s *AwsElbLoadBalancerDetails) SetCreatedTime(v string) *AwsElbLoadBalancerDetails {
+ s.CreatedTime = &v
+ return s
}
-// SetSecurityGroupIds sets the SecurityGroupIds field's value.
-func (s *AwsLambdaFunctionVpcConfig) SetSecurityGroupIds(v []*string) *AwsLambdaFunctionVpcConfig {
- s.SecurityGroupIds = v
+// SetDnsName sets the DnsName field's value.
+func (s *AwsElbLoadBalancerDetails) SetDnsName(v string) *AwsElbLoadBalancerDetails {
+ s.DnsName = &v
return s
}
-// SetSubnetIds sets the SubnetIds field's value.
-func (s *AwsLambdaFunctionVpcConfig) SetSubnetIds(v []*string) *AwsLambdaFunctionVpcConfig {
- s.SubnetIds = v
+// SetHealthCheck sets the HealthCheck field's value.
+func (s *AwsElbLoadBalancerDetails) SetHealthCheck(v *AwsElbLoadBalancerHealthCheck) *AwsElbLoadBalancerDetails {
+ s.HealthCheck = v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsLambdaFunctionVpcConfig) SetVpcId(v string) *AwsLambdaFunctionVpcConfig {
- s.VpcId = &v
+// SetInstances sets the Instances field's value.
+func (s *AwsElbLoadBalancerDetails) SetInstances(v []*AwsElbLoadBalancerInstance) *AwsElbLoadBalancerDetails {
+ s.Instances = v
return s
}
-// Details about a Lambda layer version.
-type AwsLambdaLayerVersionDetails struct {
- _ struct{} `type:"structure"`
+// SetListenerDescriptions sets the ListenerDescriptions field's value.
+func (s *AwsElbLoadBalancerDetails) SetListenerDescriptions(v []*AwsElbLoadBalancerListenerDescription) *AwsElbLoadBalancerDetails {
+ s.ListenerDescriptions = v
+ return s
+}
- // The layer's compatible runtimes. Maximum number of five items.
- //
- // Valid values: nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6
- // | python3.7 | python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5
- // | provided
- CompatibleRuntimes []*string `type:"list"`
+// SetLoadBalancerAttributes sets the LoadBalancerAttributes field's value.
+func (s *AwsElbLoadBalancerDetails) SetLoadBalancerAttributes(v *AwsElbLoadBalancerAttributes) *AwsElbLoadBalancerDetails {
+ s.LoadBalancerAttributes = v
+ return s
+}
- // Indicates when the version was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- CreatedDate *string `type:"string"`
+// SetLoadBalancerName sets the LoadBalancerName field's value.
+func (s *AwsElbLoadBalancerDetails) SetLoadBalancerName(v string) *AwsElbLoadBalancerDetails {
+ s.LoadBalancerName = &v
+ return s
+}
- // The version number.
- Version *int64 `type:"long"`
+// SetPolicies sets the Policies field's value.
+func (s *AwsElbLoadBalancerDetails) SetPolicies(v *AwsElbLoadBalancerPolicies) *AwsElbLoadBalancerDetails {
+ s.Policies = v
+ return s
}
-// String returns the string representation
-func (s AwsLambdaLayerVersionDetails) String() string {
- return awsutil.Prettify(s)
+// SetScheme sets the Scheme field's value.
+func (s *AwsElbLoadBalancerDetails) SetScheme(v string) *AwsElbLoadBalancerDetails {
+ s.Scheme = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsLambdaLayerVersionDetails) GoString() string {
- return s.String()
+// SetSecurityGroups sets the SecurityGroups field's value.
+func (s *AwsElbLoadBalancerDetails) SetSecurityGroups(v []*string) *AwsElbLoadBalancerDetails {
+ s.SecurityGroups = v
+ return s
}
-// SetCompatibleRuntimes sets the CompatibleRuntimes field's value.
-func (s *AwsLambdaLayerVersionDetails) SetCompatibleRuntimes(v []*string) *AwsLambdaLayerVersionDetails {
- s.CompatibleRuntimes = v
+// SetSourceSecurityGroup sets the SourceSecurityGroup field's value.
+func (s *AwsElbLoadBalancerDetails) SetSourceSecurityGroup(v *AwsElbLoadBalancerSourceSecurityGroup) *AwsElbLoadBalancerDetails {
+ s.SourceSecurityGroup = v
return s
}
-// SetCreatedDate sets the CreatedDate field's value.
-func (s *AwsLambdaLayerVersionDetails) SetCreatedDate(v string) *AwsLambdaLayerVersionDetails {
- s.CreatedDate = &v
+// SetSubnets sets the Subnets field's value.
+func (s *AwsElbLoadBalancerDetails) SetSubnets(v []*string) *AwsElbLoadBalancerDetails {
+ s.Subnets = v
return s
}
-// SetVersion sets the Version field's value.
-func (s *AwsLambdaLayerVersionDetails) SetVersion(v int64) *AwsLambdaLayerVersionDetails {
- s.Version = &v
+// SetVpcId sets the VpcId field's value.
+func (s *AwsElbLoadBalancerDetails) SetVpcId(v string) *AwsElbLoadBalancerDetails {
+ s.VpcId = &v
return s
}
-// An IAM role that is associated with the Amazon RDS DB cluster.
-type AwsRdsDbClusterAssociatedRole struct {
+// Contains information about the health checks that are conducted on the load
+// balancer.
+type AwsElbLoadBalancerHealthCheck struct {
_ struct{} `type:"structure"`
- // The ARN of the IAM role.
- RoleArn *string `type:"string"`
+ // The number of consecutive health check successes required before the instance
+ // is moved to the Healthy state.
+ HealthyThreshold *int64 `type:"integer"`
- // The status of the association between the IAM role and the DB cluster.
- Status *string `type:"string"`
+ // The approximate interval, in seconds, between health checks of an individual
+ // instance.
+ Interval *int64 `type:"integer"`
+
+ // The instance that is being checked. The target specifies the protocol and
+ // port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of
+ // valid ports is 1 through 65535.
+ //
+ // For the HTTP and HTTPS protocols, the target also specifies the ping path.
+ //
+ // For the TCP protocol, the target is specified as TCP: .
+ //
+ // For the SSL protocol, the target is specified as SSL. .
+ //
+ // For the HTTP and HTTPS protocols, the target is specified as :/ .
+ Target *string `type:"string"`
+
+ // The amount of time, in seconds, during which no response means a failed health
+ // check.
+ Timeout *int64 `type:"integer"`
+
+ // The number of consecutive health check failures that must occur before the
+ // instance is moved to the Unhealthy state.
+ UnhealthyThreshold *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsRdsDbClusterAssociatedRole) String() string {
+func (s AwsElbLoadBalancerHealthCheck) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbClusterAssociatedRole) GoString() string {
+func (s AwsElbLoadBalancerHealthCheck) GoString() string {
return s.String()
}
-// SetRoleArn sets the RoleArn field's value.
-func (s *AwsRdsDbClusterAssociatedRole) SetRoleArn(v string) *AwsRdsDbClusterAssociatedRole {
- s.RoleArn = &v
+// SetHealthyThreshold sets the HealthyThreshold field's value.
+func (s *AwsElbLoadBalancerHealthCheck) SetHealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck {
+ s.HealthyThreshold = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbClusterAssociatedRole) SetStatus(v string) *AwsRdsDbClusterAssociatedRole {
- s.Status = &v
+// SetInterval sets the Interval field's value.
+func (s *AwsElbLoadBalancerHealthCheck) SetInterval(v int64) *AwsElbLoadBalancerHealthCheck {
+ s.Interval = &v
return s
}
-// Information about an Amazon RDS DB cluster.
-type AwsRdsDbClusterDetails struct {
- _ struct{} `type:"structure"`
-
- // The status of the database activity stream.
- ActivityStreamStatus *string `type:"string"`
+// SetTarget sets the Target field's value.
+func (s *AwsElbLoadBalancerHealthCheck) SetTarget(v string) *AwsElbLoadBalancerHealthCheck {
+ s.Target = &v
+ return s
+}
- // For all database engines except Aurora, specifies the allocated storage size
- // in gibibytes (GiB).
- AllocatedStorage *int64 `type:"integer"`
-
- // A list of the IAM roles that are associated with the DB cluster.
- AssociatedRoles []*AwsRdsDbClusterAssociatedRole `type:"list"`
-
- // A list of Availability Zones (AZs) where instances in the DB cluster can
- // be created.
- AvailabilityZones []*string `type:"list"`
-
- // The number of days for which automated backups are retained.
- BackupRetentionPeriod *int64 `type:"integer"`
-
- // Indicates when the DB cluster was created, in Universal Coordinated Time
- // (UTC).
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- ClusterCreateTime *string `type:"string"`
-
- // Whether tags are copied from the DB cluster to snapshots of the DB cluster.
- CopyTagsToSnapshot *bool `type:"boolean"`
-
- // Whether the DB cluster is a clone of a DB cluster owned by a different AWS
- // account.
- CrossAccountClone *bool `type:"boolean"`
-
- // A list of custom endpoints for the DB cluster.
- CustomEndpoints []*string `type:"list"`
-
- // The name of the database.
- DatabaseName *string `type:"string"`
-
- // The DB cluster identifier that the user assigned to the cluster. This identifier
- // is the unique key that identifies a DB cluster.
- DbClusterIdentifier *string `type:"string"`
-
- // The list of instances that make up the DB cluster.
- DbClusterMembers []*AwsRdsDbClusterMember `type:"list"`
-
- // The list of option group memberships for this DB cluster.
- DbClusterOptionGroupMemberships []*AwsRdsDbClusterOptionGroupMembership `type:"list"`
-
- // The name of the DB cluster parameter group for the DB cluster.
- DbClusterParameterGroup *string `type:"string"`
-
- // The identifier of the DB cluster. The identifier must be unique within each
- // AWS Region and is immutable.
- DbClusterResourceId *string `type:"string"`
-
- // The subnet group that is associated with the DB cluster, including the name,
- // description, and subnets in the subnet group.
- DbSubnetGroup *string `type:"string"`
-
- // Whether the DB cluster has deletion protection enabled.
- DeletionProtection *bool `type:"boolean"`
-
- // The Active Directory domain membership records that are associated with the
- // DB cluster.
- DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`
-
- // A list of log types that this DB cluster is configured to export to CloudWatch
- // Logs.
- EnabledCloudWatchLogsExports []*string `type:"list"`
-
- // The connection endpoint for the primary instance of the DB cluster.
- Endpoint *string `type:"string"`
-
- // The name of the database engine to use for this DB cluster.
- Engine *string `type:"string"`
-
- // The database engine mode of the DB cluster.
- EngineMode *string `type:"string"`
+// SetTimeout sets the Timeout field's value.
+func (s *AwsElbLoadBalancerHealthCheck) SetTimeout(v int64) *AwsElbLoadBalancerHealthCheck {
+ s.Timeout = &v
+ return s
+}
- // The version number of the database engine to use.
- EngineVersion *string `type:"string"`
+// SetUnhealthyThreshold sets the UnhealthyThreshold field's value.
+func (s *AwsElbLoadBalancerHealthCheck) SetUnhealthyThreshold(v int64) *AwsElbLoadBalancerHealthCheck {
+ s.UnhealthyThreshold = &v
+ return s
+}
- // Specifies the identifier that Amazon Route 53 assigns when you create a hosted
- // zone.
- HostedZoneId *string `type:"string"`
+// Provides information about an EC2 instance for a load balancer.
+type AwsElbLoadBalancerInstance struct {
+ _ struct{} `type:"structure"`
- // Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
- HttpEndpointEnabled *bool `type:"boolean"`
+ // The instance identifier.
+ InstanceId *string `type:"string"`
+}
- // Whether the mapping of IAM accounts to database accounts is enabled.
- IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
+// String returns the string representation
+func (s AwsElbLoadBalancerInstance) String() string {
+ return awsutil.Prettify(s)
+}
- // The ARN of the AWS KMS master key that is used to encrypt the database instances
- // in the DB cluster.
- KmsKeyId *string `type:"string"`
+// GoString returns the string representation
+func (s AwsElbLoadBalancerInstance) GoString() string {
+ return s.String()
+}
- // The name of the master user for the DB cluster.
- MasterUsername *string `type:"string"`
+// SetInstanceId sets the InstanceId field's value.
+func (s *AwsElbLoadBalancerInstance) SetInstanceId(v string) *AwsElbLoadBalancerInstance {
+ s.InstanceId = &v
+ return s
+}
- // Whether the DB cluster has instances in multiple Availability Zones.
- MultiAz *bool `type:"boolean"`
+// Information about a load balancer listener.
+type AwsElbLoadBalancerListener struct {
+ _ struct{} `type:"structure"`
- // The port number on which the DB instances in the DB cluster accept connections.
- Port *int64 `type:"integer"`
+ // The port on which the instance is listening.
+ InstancePort *int64 `type:"integer"`
- // The range of time each day when automated backups are created, if automated
- // backups are enabled.
+ // The protocol to use to route traffic to instances.
//
- // Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
- PreferredBackupWindow *string `type:"string"`
+ // Valid values: HTTP | HTTPS | TCP | SSL
+ InstanceProtocol *string `type:"string"`
- // The weekly time range during which system maintenance can occur, in Universal
- // Coordinated Time (UTC).
- //
- // Uses the format :HH:MM-:HH:MM.
+ // The port on which the load balancer is listening.
//
- // For the day values, use mon|tue|wed|thu|fri|sat|sun.
+ // On EC2-VPC, you can specify any port from the range 1-65535.
//
- // For example, sun:09:32-sun:10:02.
- PreferredMaintenanceWindow *string `type:"string"`
-
- // The identifiers of the read replicas that are associated with this DB cluster.
- ReadReplicaIdentifiers []*string `type:"list"`
-
- // The reader endpoint for the DB cluster.
- ReaderEndpoint *string `type:"string"`
-
- // The current status of this DB cluster.
- Status *string `type:"string"`
+ // On EC2-Classic, you can specify any port from the following list: 25, 80,
+ // 443, 465, 587, 1024-65535.
+ LoadBalancerPort *int64 `type:"integer"`
- // Whether the DB cluster is encrypted.
- StorageEncrypted *bool `type:"boolean"`
+ // The load balancer transport protocol to use for routing.
+ //
+ // Valid values: HTTP | HTTPS | TCP | SSL
+ Protocol *string `type:"string"`
- // A list of VPC security groups that the DB cluster belongs to.
- VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
+ // The ARN of the server certificate.
+ SslCertificateId *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbClusterDetails) String() string {
+func (s AwsElbLoadBalancerListener) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbClusterDetails) GoString() string {
+func (s AwsElbLoadBalancerListener) GoString() string {
return s.String()
}
-// SetActivityStreamStatus sets the ActivityStreamStatus field's value.
-func (s *AwsRdsDbClusterDetails) SetActivityStreamStatus(v string) *AwsRdsDbClusterDetails {
- s.ActivityStreamStatus = &v
+// SetInstancePort sets the InstancePort field's value.
+func (s *AwsElbLoadBalancerListener) SetInstancePort(v int64) *AwsElbLoadBalancerListener {
+ s.InstancePort = &v
return s
}
-// SetAllocatedStorage sets the AllocatedStorage field's value.
-func (s *AwsRdsDbClusterDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterDetails {
- s.AllocatedStorage = &v
+// SetInstanceProtocol sets the InstanceProtocol field's value.
+func (s *AwsElbLoadBalancerListener) SetInstanceProtocol(v string) *AwsElbLoadBalancerListener {
+ s.InstanceProtocol = &v
return s
}
-// SetAssociatedRoles sets the AssociatedRoles field's value.
-func (s *AwsRdsDbClusterDetails) SetAssociatedRoles(v []*AwsRdsDbClusterAssociatedRole) *AwsRdsDbClusterDetails {
- s.AssociatedRoles = v
+// SetLoadBalancerPort sets the LoadBalancerPort field's value.
+func (s *AwsElbLoadBalancerListener) SetLoadBalancerPort(v int64) *AwsElbLoadBalancerListener {
+ s.LoadBalancerPort = &v
return s
}
-// SetAvailabilityZones sets the AvailabilityZones field's value.
-func (s *AwsRdsDbClusterDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterDetails {
- s.AvailabilityZones = v
+// SetProtocol sets the Protocol field's value.
+func (s *AwsElbLoadBalancerListener) SetProtocol(v string) *AwsElbLoadBalancerListener {
+ s.Protocol = &v
return s
}
-// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
-func (s *AwsRdsDbClusterDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbClusterDetails {
- s.BackupRetentionPeriod = &v
+// SetSslCertificateId sets the SslCertificateId field's value.
+func (s *AwsElbLoadBalancerListener) SetSslCertificateId(v string) *AwsElbLoadBalancerListener {
+ s.SslCertificateId = &v
return s
}
-// SetClusterCreateTime sets the ClusterCreateTime field's value.
-func (s *AwsRdsDbClusterDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterDetails {
- s.ClusterCreateTime = &v
- return s
-}
+// Lists the policies that are enabled for a load balancer listener.
+type AwsElbLoadBalancerListenerDescription struct {
+ _ struct{} `type:"structure"`
-// SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.
-func (s *AwsRdsDbClusterDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbClusterDetails {
- s.CopyTagsToSnapshot = &v
- return s
-}
+ // Information about the listener.
+ Listener *AwsElbLoadBalancerListener `type:"structure"`
-// SetCrossAccountClone sets the CrossAccountClone field's value.
-func (s *AwsRdsDbClusterDetails) SetCrossAccountClone(v bool) *AwsRdsDbClusterDetails {
- s.CrossAccountClone = &v
- return s
+ // The policies enabled for the listener.
+ PolicyNames []*string `type:"list"`
}
-// SetCustomEndpoints sets the CustomEndpoints field's value.
-func (s *AwsRdsDbClusterDetails) SetCustomEndpoints(v []*string) *AwsRdsDbClusterDetails {
- s.CustomEndpoints = v
- return s
+// String returns the string representation
+func (s AwsElbLoadBalancerListenerDescription) String() string {
+ return awsutil.Prettify(s)
}
-// SetDatabaseName sets the DatabaseName field's value.
-func (s *AwsRdsDbClusterDetails) SetDatabaseName(v string) *AwsRdsDbClusterDetails {
- s.DatabaseName = &v
- return s
+// GoString returns the string representation
+func (s AwsElbLoadBalancerListenerDescription) GoString() string {
+ return s.String()
}
-// SetDbClusterIdentifier sets the DbClusterIdentifier field's value.
-func (s *AwsRdsDbClusterDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterDetails {
- s.DbClusterIdentifier = &v
+// SetListener sets the Listener field's value.
+func (s *AwsElbLoadBalancerListenerDescription) SetListener(v *AwsElbLoadBalancerListener) *AwsElbLoadBalancerListenerDescription {
+ s.Listener = v
return s
}
-// SetDbClusterMembers sets the DbClusterMembers field's value.
-func (s *AwsRdsDbClusterDetails) SetDbClusterMembers(v []*AwsRdsDbClusterMember) *AwsRdsDbClusterDetails {
- s.DbClusterMembers = v
+// SetPolicyNames sets the PolicyNames field's value.
+func (s *AwsElbLoadBalancerListenerDescription) SetPolicyNames(v []*string) *AwsElbLoadBalancerListenerDescription {
+ s.PolicyNames = v
return s
}
-// SetDbClusterOptionGroupMemberships sets the DbClusterOptionGroupMemberships field's value.
-func (s *AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships(v []*AwsRdsDbClusterOptionGroupMembership) *AwsRdsDbClusterDetails {
- s.DbClusterOptionGroupMemberships = v
- return s
-}
+// Contains information about the policies for a load balancer.
+type AwsElbLoadBalancerPolicies struct {
+ _ struct{} `type:"structure"`
-// SetDbClusterParameterGroup sets the DbClusterParameterGroup field's value.
-func (s *AwsRdsDbClusterDetails) SetDbClusterParameterGroup(v string) *AwsRdsDbClusterDetails {
- s.DbClusterParameterGroup = &v
- return s
+ // The stickiness policies that are created using CreateAppCookieStickinessPolicy.
+ AppCookieStickinessPolicies []*AwsElbAppCookieStickinessPolicy `type:"list"`
+
+ // The stickiness policies that are created using CreateLBCookieStickinessPolicy.
+ LbCookieStickinessPolicies []*AwsElbLbCookieStickinessPolicy `type:"list"`
+
+ // The policies other than the stickiness policies.
+ OtherPolicies []*string `type:"list"`
}
-// SetDbClusterResourceId sets the DbClusterResourceId field's value.
-func (s *AwsRdsDbClusterDetails) SetDbClusterResourceId(v string) *AwsRdsDbClusterDetails {
- s.DbClusterResourceId = &v
- return s
+// String returns the string representation
+func (s AwsElbLoadBalancerPolicies) String() string {
+ return awsutil.Prettify(s)
}
-// SetDbSubnetGroup sets the DbSubnetGroup field's value.
-func (s *AwsRdsDbClusterDetails) SetDbSubnetGroup(v string) *AwsRdsDbClusterDetails {
- s.DbSubnetGroup = &v
- return s
+// GoString returns the string representation
+func (s AwsElbLoadBalancerPolicies) GoString() string {
+ return s.String()
}
-// SetDeletionProtection sets the DeletionProtection field's value.
-func (s *AwsRdsDbClusterDetails) SetDeletionProtection(v bool) *AwsRdsDbClusterDetails {
- s.DeletionProtection = &v
+// SetAppCookieStickinessPolicies sets the AppCookieStickinessPolicies field's value.
+func (s *AwsElbLoadBalancerPolicies) SetAppCookieStickinessPolicies(v []*AwsElbAppCookieStickinessPolicy) *AwsElbLoadBalancerPolicies {
+ s.AppCookieStickinessPolicies = v
return s
}
-// SetDomainMemberships sets the DomainMemberships field's value.
-func (s *AwsRdsDbClusterDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbClusterDetails {
- s.DomainMemberships = v
+// SetLbCookieStickinessPolicies sets the LbCookieStickinessPolicies field's value.
+func (s *AwsElbLoadBalancerPolicies) SetLbCookieStickinessPolicies(v []*AwsElbLbCookieStickinessPolicy) *AwsElbLoadBalancerPolicies {
+ s.LbCookieStickinessPolicies = v
return s
}
-// SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.
-func (s *AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbClusterDetails {
- s.EnabledCloudWatchLogsExports = v
+// SetOtherPolicies sets the OtherPolicies field's value.
+func (s *AwsElbLoadBalancerPolicies) SetOtherPolicies(v []*string) *AwsElbLoadBalancerPolicies {
+ s.OtherPolicies = v
return s
}
-// SetEndpoint sets the Endpoint field's value.
-func (s *AwsRdsDbClusterDetails) SetEndpoint(v string) *AwsRdsDbClusterDetails {
- s.Endpoint = &v
- return s
+// Contains information about the security group for the load balancer.
+type AwsElbLoadBalancerSourceSecurityGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the security group.
+ GroupName *string `type:"string"`
+
+ // The owner of the security group.
+ OwnerAlias *string `type:"string"`
}
-// SetEngine sets the Engine field's value.
-func (s *AwsRdsDbClusterDetails) SetEngine(v string) *AwsRdsDbClusterDetails {
- s.Engine = &v
- return s
+// String returns the string representation
+func (s AwsElbLoadBalancerSourceSecurityGroup) String() string {
+ return awsutil.Prettify(s)
}
-// SetEngineMode sets the EngineMode field's value.
-func (s *AwsRdsDbClusterDetails) SetEngineMode(v string) *AwsRdsDbClusterDetails {
- s.EngineMode = &v
- return s
+// GoString returns the string representation
+func (s AwsElbLoadBalancerSourceSecurityGroup) GoString() string {
+ return s.String()
}
-// SetEngineVersion sets the EngineVersion field's value.
-func (s *AwsRdsDbClusterDetails) SetEngineVersion(v string) *AwsRdsDbClusterDetails {
- s.EngineVersion = &v
+// SetGroupName sets the GroupName field's value.
+func (s *AwsElbLoadBalancerSourceSecurityGroup) SetGroupName(v string) *AwsElbLoadBalancerSourceSecurityGroup {
+ s.GroupName = &v
return s
}
-// SetHostedZoneId sets the HostedZoneId field's value.
-func (s *AwsRdsDbClusterDetails) SetHostedZoneId(v string) *AwsRdsDbClusterDetails {
- s.HostedZoneId = &v
+// SetOwnerAlias sets the OwnerAlias field's value.
+func (s *AwsElbLoadBalancerSourceSecurityGroup) SetOwnerAlias(v string) *AwsElbLoadBalancerSourceSecurityGroup {
+ s.OwnerAlias = &v
return s
}
-// SetHttpEndpointEnabled sets the HttpEndpointEnabled field's value.
-func (s *AwsRdsDbClusterDetails) SetHttpEndpointEnabled(v bool) *AwsRdsDbClusterDetails {
- s.HttpEndpointEnabled = &v
- return s
+// Information about a load balancer.
+type AwsElbv2LoadBalancerDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The Availability Zones for the load balancer.
+ AvailabilityZones []*AvailabilityZone `type:"list"`
+
+ // The ID of the Amazon Route 53 hosted zone associated with the load balancer.
+ CanonicalHostedZoneId *string `type:"string"`
+
+ // Indicates when the load balancer was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreatedTime *string `type:"string"`
+
+ // The public DNS name of the load balancer.
+ DNSName *string `type:"string"`
+
+ // The type of IP addresses used by the subnets for your load balancer. The
+ // possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and
+ // IPv6 addresses).
+ IpAddressType *string `type:"string"`
+
+ // The nodes of an Internet-facing load balancer have public IP addresses.
+ Scheme *string `type:"string"`
+
+ // The IDs of the security groups for the load balancer.
+ SecurityGroups []*string `type:"list"`
+
+ // The state of the load balancer.
+ State *LoadBalancerState `type:"structure"`
+
+ // The type of load balancer.
+ Type *string `type:"string"`
+
+ // The ID of the VPC for the load balancer.
+ VpcId *string `type:"string"`
}
-// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
-func (s *AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterDetails {
- s.IamDatabaseAuthenticationEnabled = &v
- return s
+// String returns the string representation
+func (s AwsElbv2LoadBalancerDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsRdsDbClusterDetails) SetKmsKeyId(v string) *AwsRdsDbClusterDetails {
- s.KmsKeyId = &v
- return s
+// GoString returns the string representation
+func (s AwsElbv2LoadBalancerDetails) GoString() string {
+ return s.String()
}
-// SetMasterUsername sets the MasterUsername field's value.
-func (s *AwsRdsDbClusterDetails) SetMasterUsername(v string) *AwsRdsDbClusterDetails {
- s.MasterUsername = &v
+// SetAvailabilityZones sets the AvailabilityZones field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetAvailabilityZones(v []*AvailabilityZone) *AwsElbv2LoadBalancerDetails {
+ s.AvailabilityZones = v
return s
}
-// SetMultiAz sets the MultiAz field's value.
-func (s *AwsRdsDbClusterDetails) SetMultiAz(v bool) *AwsRdsDbClusterDetails {
- s.MultiAz = &v
+// SetCanonicalHostedZoneId sets the CanonicalHostedZoneId field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetCanonicalHostedZoneId(v string) *AwsElbv2LoadBalancerDetails {
+ s.CanonicalHostedZoneId = &v
return s
}
-// SetPort sets the Port field's value.
-func (s *AwsRdsDbClusterDetails) SetPort(v int64) *AwsRdsDbClusterDetails {
- s.Port = &v
+// SetCreatedTime sets the CreatedTime field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetCreatedTime(v string) *AwsElbv2LoadBalancerDetails {
+ s.CreatedTime = &v
return s
}
-// SetPreferredBackupWindow sets the PreferredBackupWindow field's value.
-func (s *AwsRdsDbClusterDetails) SetPreferredBackupWindow(v string) *AwsRdsDbClusterDetails {
- s.PreferredBackupWindow = &v
+// SetDNSName sets the DNSName field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetDNSName(v string) *AwsElbv2LoadBalancerDetails {
+ s.DNSName = &v
return s
}
-// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
-func (s *AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbClusterDetails {
- s.PreferredMaintenanceWindow = &v
+// SetIpAddressType sets the IpAddressType field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetIpAddressType(v string) *AwsElbv2LoadBalancerDetails {
+ s.IpAddressType = &v
return s
}
-// SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.
-func (s *AwsRdsDbClusterDetails) SetReadReplicaIdentifiers(v []*string) *AwsRdsDbClusterDetails {
- s.ReadReplicaIdentifiers = v
+// SetScheme sets the Scheme field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetScheme(v string) *AwsElbv2LoadBalancerDetails {
+ s.Scheme = &v
return s
}
-// SetReaderEndpoint sets the ReaderEndpoint field's value.
-func (s *AwsRdsDbClusterDetails) SetReaderEndpoint(v string) *AwsRdsDbClusterDetails {
- s.ReaderEndpoint = &v
+// SetSecurityGroups sets the SecurityGroups field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetSecurityGroups(v []*string) *AwsElbv2LoadBalancerDetails {
+ s.SecurityGroups = v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbClusterDetails) SetStatus(v string) *AwsRdsDbClusterDetails {
- s.Status = &v
+// SetState sets the State field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetState(v *LoadBalancerState) *AwsElbv2LoadBalancerDetails {
+ s.State = v
return s
}
-// SetStorageEncrypted sets the StorageEncrypted field's value.
-func (s *AwsRdsDbClusterDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterDetails {
- s.StorageEncrypted = &v
+// SetType sets the Type field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetType(v string) *AwsElbv2LoadBalancerDetails {
+ s.Type = &v
return s
}
-// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
-func (s *AwsRdsDbClusterDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbClusterDetails {
- s.VpcSecurityGroups = v
+// SetVpcId sets the VpcId field's value.
+func (s *AwsElbv2LoadBalancerDetails) SetVpcId(v string) *AwsElbv2LoadBalancerDetails {
+ s.VpcId = &v
return s
}
-// Information about an instance in the DB cluster.
-type AwsRdsDbClusterMember struct {
+// IAM access key details related to a finding.
+type AwsIamAccessKeyDetails struct {
_ struct{} `type:"structure"`
- // The status of the DB cluster parameter group for this member of the DB cluster.
- DbClusterParameterGroupStatus *string `type:"string"`
+ // The identifier of the access key.
+ AccessKeyId *string `type:"string"`
- // The instance identifier for this member of the DB cluster.
- DbInstanceIdentifier *string `type:"string"`
+ // The AWS account ID of the account for the key.
+ AccountId *string `type:"string"`
- // Whether the cluster member is the primary instance for the DB cluster.
- IsClusterWriter *bool `type:"boolean"`
+ // Indicates when the IAM access key was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreatedAt *string `type:"string"`
- // Specifies the order in which an Aurora replica is promoted to the primary
- // instance when the existing primary instance fails.
- PromotionTier *int64 `type:"integer"`
+ // The ID of the principal associated with an access key.
+ PrincipalId *string `type:"string"`
+
+ // The name of the principal.
+ PrincipalName *string `type:"string"`
+
+ // The type of principal associated with an access key.
+ PrincipalType *string `type:"string"`
+
+ // Information about the session that the key was used for.
+ SessionContext *AwsIamAccessKeySessionContext `type:"structure"`
+
+ // The status of the IAM access key related to a finding.
+ Status *string `type:"string" enum:"AwsIamAccessKeyStatus"`
+
+ // The user associated with the IAM access key related to a finding.
+ //
+ // The UserName parameter has been replaced with the PrincipalName parameter
+ // because access keys can also be assigned to principals that are not IAM users.
+ //
+ // Deprecated: This filter is deprecated. Instead, use PrincipalName.
+ UserName *string `deprecated:"true" type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbClusterMember) String() string {
+func (s AwsIamAccessKeyDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbClusterMember) GoString() string {
+func (s AwsIamAccessKeyDetails) GoString() string {
return s.String()
}
-// SetDbClusterParameterGroupStatus sets the DbClusterParameterGroupStatus field's value.
-func (s *AwsRdsDbClusterMember) SetDbClusterParameterGroupStatus(v string) *AwsRdsDbClusterMember {
- s.DbClusterParameterGroupStatus = &v
+// SetAccessKeyId sets the AccessKeyId field's value.
+func (s *AwsIamAccessKeyDetails) SetAccessKeyId(v string) *AwsIamAccessKeyDetails {
+ s.AccessKeyId = &v
return s
}
-// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
-func (s *AwsRdsDbClusterMember) SetDbInstanceIdentifier(v string) *AwsRdsDbClusterMember {
- s.DbInstanceIdentifier = &v
- return s
+// SetAccountId sets the AccountId field's value.
+func (s *AwsIamAccessKeyDetails) SetAccountId(v string) *AwsIamAccessKeyDetails {
+ s.AccountId = &v
+ return s
}
-// SetIsClusterWriter sets the IsClusterWriter field's value.
-func (s *AwsRdsDbClusterMember) SetIsClusterWriter(v bool) *AwsRdsDbClusterMember {
- s.IsClusterWriter = &v
+// SetCreatedAt sets the CreatedAt field's value.
+func (s *AwsIamAccessKeyDetails) SetCreatedAt(v string) *AwsIamAccessKeyDetails {
+ s.CreatedAt = &v
return s
}
-// SetPromotionTier sets the PromotionTier field's value.
-func (s *AwsRdsDbClusterMember) SetPromotionTier(v int64) *AwsRdsDbClusterMember {
- s.PromotionTier = &v
+// SetPrincipalId sets the PrincipalId field's value.
+func (s *AwsIamAccessKeyDetails) SetPrincipalId(v string) *AwsIamAccessKeyDetails {
+ s.PrincipalId = &v
return s
}
-// Information about an option group membership for a DB cluster.
-type AwsRdsDbClusterOptionGroupMembership struct {
+// SetPrincipalName sets the PrincipalName field's value.
+func (s *AwsIamAccessKeyDetails) SetPrincipalName(v string) *AwsIamAccessKeyDetails {
+ s.PrincipalName = &v
+ return s
+}
+
+// SetPrincipalType sets the PrincipalType field's value.
+func (s *AwsIamAccessKeyDetails) SetPrincipalType(v string) *AwsIamAccessKeyDetails {
+ s.PrincipalType = &v
+ return s
+}
+
+// SetSessionContext sets the SessionContext field's value.
+func (s *AwsIamAccessKeyDetails) SetSessionContext(v *AwsIamAccessKeySessionContext) *AwsIamAccessKeyDetails {
+ s.SessionContext = v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsIamAccessKeyDetails) SetStatus(v string) *AwsIamAccessKeyDetails {
+ s.Status = &v
+ return s
+}
+
+// SetUserName sets the UserName field's value.
+func (s *AwsIamAccessKeyDetails) SetUserName(v string) *AwsIamAccessKeyDetails {
+ s.UserName = &v
+ return s
+}
+
+// Provides information about the session that the key was used for.
+type AwsIamAccessKeySessionContext struct {
_ struct{} `type:"structure"`
- // The name of the DB cluster option group.
- DbClusterOptionGroupName *string `type:"string"`
+ // Attributes of the session that the key was used for.
+ Attributes *AwsIamAccessKeySessionContextAttributes `type:"structure"`
- // The status of the DB cluster option group.
- Status *string `type:"string"`
+ // Information about the entity that created the session.
+ SessionIssuer *AwsIamAccessKeySessionContextSessionIssuer `type:"structure"`
}
// String returns the string representation
-func (s AwsRdsDbClusterOptionGroupMembership) String() string {
+func (s AwsIamAccessKeySessionContext) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbClusterOptionGroupMembership) GoString() string {
+func (s AwsIamAccessKeySessionContext) GoString() string {
return s.String()
}
-// SetDbClusterOptionGroupName sets the DbClusterOptionGroupName field's value.
-func (s *AwsRdsDbClusterOptionGroupMembership) SetDbClusterOptionGroupName(v string) *AwsRdsDbClusterOptionGroupMembership {
- s.DbClusterOptionGroupName = &v
+// SetAttributes sets the Attributes field's value.
+func (s *AwsIamAccessKeySessionContext) SetAttributes(v *AwsIamAccessKeySessionContextAttributes) *AwsIamAccessKeySessionContext {
+ s.Attributes = v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbClusterOptionGroupMembership) SetStatus(v string) *AwsRdsDbClusterOptionGroupMembership {
- s.Status = &v
+// SetSessionIssuer sets the SessionIssuer field's value.
+func (s *AwsIamAccessKeySessionContext) SetSessionIssuer(v *AwsIamAccessKeySessionContextSessionIssuer) *AwsIamAccessKeySessionContext {
+ s.SessionIssuer = v
return s
}
-// Information about an Amazon RDS DB cluster snapshot.
-type AwsRdsDbClusterSnapshotDetails struct {
+// Attributes of the session that the key was used for.
+type AwsIamAccessKeySessionContextAttributes struct {
_ struct{} `type:"structure"`
- // Specifies the allocated storage size in gibibytes (GiB).
- AllocatedStorage *int64 `type:"integer"`
-
- // A list of Availability Zones where instances in the DB cluster can be created.
- AvailabilityZones []*string `type:"list"`
-
- // Indicates when the DB cluster was created, in Universal Coordinated Time
- // (UTC).
+ // Indicates when the session was created.
//
// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
// contain spaces. For example, 2020-03-22T13:22:13.933Z.
- ClusterCreateTime *string `type:"string"`
-
- // The DB cluster identifier.
- DbClusterIdentifier *string `type:"string"`
-
- // The identifier of the DB cluster snapshot.
- DbClusterSnapshotIdentifier *string `type:"string"`
-
- // The name of the database engine that you want to use for this DB instance.
- Engine *string `type:"string"`
-
- // The version of the database engine to use.
- EngineVersion *string `type:"string"`
+ CreationDate *string `type:"string"`
- // Whether mapping of IAM accounts to database accounts is enabled.
- IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
+ // Indicates whether the session used multi-factor authentication (MFA).
+ MfaAuthenticated *bool `type:"boolean"`
+}
- // The ARN of the AWS KMS master key that is used to encrypt the database instances
- // in the DB cluster.
- KmsKeyId *string `type:"string"`
+// String returns the string representation
+func (s AwsIamAccessKeySessionContextAttributes) String() string {
+ return awsutil.Prettify(s)
+}
- // The license model information for this DB cluster snapshot.
- LicenseModel *string `type:"string"`
+// GoString returns the string representation
+func (s AwsIamAccessKeySessionContextAttributes) GoString() string {
+ return s.String()
+}
- // The name of the master user for the DB cluster.
- MasterUsername *string `type:"string"`
+// SetCreationDate sets the CreationDate field's value.
+func (s *AwsIamAccessKeySessionContextAttributes) SetCreationDate(v string) *AwsIamAccessKeySessionContextAttributes {
+ s.CreationDate = &v
+ return s
+}
- // Specifies the percentage of the estimated data that has been transferred.
- PercentProgress *int64 `type:"integer"`
+// SetMfaAuthenticated sets the MfaAuthenticated field's value.
+func (s *AwsIamAccessKeySessionContextAttributes) SetMfaAuthenticated(v bool) *AwsIamAccessKeySessionContextAttributes {
+ s.MfaAuthenticated = &v
+ return s
+}
- // The port number on which the DB instances in the DB cluster accept connections.
- Port *int64 `type:"integer"`
+// Information about the entity that created the session.
+type AwsIamAccessKeySessionContextSessionIssuer struct {
+ _ struct{} `type:"structure"`
- // Indicates when the snapshot was taken.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- SnapshotCreateTime *string `type:"string"`
+ // The identifier of the AWS account that created the session.
+ AccountId *string `type:"string"`
- // The type of DB cluster snapshot.
- SnapshotType *string `type:"string"`
+ // The ARN of the session.
+ Arn *string `type:"string"`
- // The status of this DB cluster snapshot.
- Status *string `type:"string"`
+ // The principal ID of the principal (user, role, or group) that created the
+ // session.
+ PrincipalId *string `type:"string"`
- // Whether the DB cluster is encrypted.
- StorageEncrypted *bool `type:"boolean"`
+ // The type of principal (user, role, or group) that created the session.
+ Type *string `type:"string"`
- // The VPC ID that is associated with the DB cluster snapshot.
- VpcId *string `type:"string"`
+ // The name of the principal that created the session.
+ UserName *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbClusterSnapshotDetails) String() string {
+func (s AwsIamAccessKeySessionContextSessionIssuer) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbClusterSnapshotDetails) GoString() string {
+func (s AwsIamAccessKeySessionContextSessionIssuer) GoString() string {
return s.String()
}
-// SetAllocatedStorage sets the AllocatedStorage field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterSnapshotDetails {
- s.AllocatedStorage = &v
+// SetAccountId sets the AccountId field's value.
+func (s *AwsIamAccessKeySessionContextSessionIssuer) SetAccountId(v string) *AwsIamAccessKeySessionContextSessionIssuer {
+ s.AccountId = &v
return s
}
-// SetAvailabilityZones sets the AvailabilityZones field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterSnapshotDetails {
- s.AvailabilityZones = v
+// SetArn sets the Arn field's value.
+func (s *AwsIamAccessKeySessionContextSessionIssuer) SetArn(v string) *AwsIamAccessKeySessionContextSessionIssuer {
+ s.Arn = &v
return s
}
-// SetClusterCreateTime sets the ClusterCreateTime field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterSnapshotDetails {
- s.ClusterCreateTime = &v
+// SetPrincipalId sets the PrincipalId field's value.
+func (s *AwsIamAccessKeySessionContextSessionIssuer) SetPrincipalId(v string) *AwsIamAccessKeySessionContextSessionIssuer {
+ s.PrincipalId = &v
return s
}
-// SetDbClusterIdentifier sets the DbClusterIdentifier field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterSnapshotDetails {
- s.DbClusterIdentifier = &v
+// SetType sets the Type field's value.
+func (s *AwsIamAccessKeySessionContextSessionIssuer) SetType(v string) *AwsIamAccessKeySessionContextSessionIssuer {
+ s.Type = &v
return s
}
-// SetDbClusterSnapshotIdentifier sets the DbClusterSnapshotIdentifier field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier(v string) *AwsRdsDbClusterSnapshotDetails {
- s.DbClusterSnapshotIdentifier = &v
+// SetUserName sets the UserName field's value.
+func (s *AwsIamAccessKeySessionContextSessionIssuer) SetUserName(v string) *AwsIamAccessKeySessionContextSessionIssuer {
+ s.UserName = &v
return s
}
-// SetEngine sets the Engine field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetEngine(v string) *AwsRdsDbClusterSnapshotDetails {
- s.Engine = &v
- return s
-}
+// A managed policy that is attached to an IAM principal.
+type AwsIamAttachedManagedPolicy struct {
+ _ struct{} `type:"structure"`
-// SetEngineVersion sets the EngineVersion field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbClusterSnapshotDetails {
- s.EngineVersion = &v
- return s
-}
+ // The ARN of the policy.
+ PolicyArn *string `type:"string"`
-// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterSnapshotDetails {
- s.IamDatabaseAuthenticationEnabled = &v
- return s
+ // The name of the policy.
+ PolicyName *string `type:"string"`
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbClusterSnapshotDetails {
- s.KmsKeyId = &v
- return s
+// String returns the string representation
+func (s AwsIamAttachedManagedPolicy) String() string {
+ return awsutil.Prettify(s)
}
-// SetLicenseModel sets the LicenseModel field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbClusterSnapshotDetails {
- s.LicenseModel = &v
- return s
+// GoString returns the string representation
+func (s AwsIamAttachedManagedPolicy) GoString() string {
+ return s.String()
}
-// SetMasterUsername sets the MasterUsername field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbClusterSnapshotDetails {
- s.MasterUsername = &v
+// SetPolicyArn sets the PolicyArn field's value.
+func (s *AwsIamAttachedManagedPolicy) SetPolicyArn(v string) *AwsIamAttachedManagedPolicy {
+ s.PolicyArn = &v
return s
}
-// SetPercentProgress sets the PercentProgress field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbClusterSnapshotDetails {
- s.PercentProgress = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsIamAttachedManagedPolicy) SetPolicyName(v string) *AwsIamAttachedManagedPolicy {
+ s.PolicyName = &v
return s
}
-// SetPort sets the Port field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetPort(v int64) *AwsRdsDbClusterSnapshotDetails {
- s.Port = &v
- return s
-}
+// Contains details about an IAM group.
+type AwsIamGroupDetails struct {
+ _ struct{} `type:"structure"`
-// SetSnapshotCreateTime sets the SnapshotCreateTime field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbClusterSnapshotDetails {
- s.SnapshotCreateTime = &v
- return s
+ // A list of the managed policies that are attached to the IAM group.
+ AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
+
+ // Indicates when the IAM group was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
+
+ // The identifier of the IAM group.
+ GroupId *string `type:"string"`
+
+ // The name of the IAM group.
+ GroupName *string `type:"string"`
+
+ // The list of inline policies that are embedded in the group.
+ GroupPolicyList []*AwsIamGroupPolicy `type:"list"`
+
+ // The path to the group.
+ Path *string `type:"string"`
}
-// SetSnapshotType sets the SnapshotType field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbClusterSnapshotDetails {
- s.SnapshotType = &v
- return s
+// String returns the string representation
+func (s AwsIamGroupDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetStatus(v string) *AwsRdsDbClusterSnapshotDetails {
- s.Status = &v
+// GoString returns the string representation
+func (s AwsIamGroupDetails) GoString() string {
+ return s.String()
+}
+
+// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
+func (s *AwsIamGroupDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamGroupDetails {
+ s.AttachedManagedPolicies = v
return s
}
-// SetStorageEncrypted sets the StorageEncrypted field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterSnapshotDetails {
- s.StorageEncrypted = &v
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamGroupDetails) SetCreateDate(v string) *AwsIamGroupDetails {
+ s.CreateDate = &v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsRdsDbClusterSnapshotDetails) SetVpcId(v string) *AwsRdsDbClusterSnapshotDetails {
- s.VpcId = &v
+// SetGroupId sets the GroupId field's value.
+func (s *AwsIamGroupDetails) SetGroupId(v string) *AwsIamGroupDetails {
+ s.GroupId = &v
return s
}
-// Information about an Active Directory domain membership record associated
-// with the DB instance.
-type AwsRdsDbDomainMembership struct {
- _ struct{} `type:"structure"`
+// SetGroupName sets the GroupName field's value.
+func (s *AwsIamGroupDetails) SetGroupName(v string) *AwsIamGroupDetails {
+ s.GroupName = &v
+ return s
+}
- // The identifier of the Active Directory domain.
- Domain *string `type:"string"`
+// SetGroupPolicyList sets the GroupPolicyList field's value.
+func (s *AwsIamGroupDetails) SetGroupPolicyList(v []*AwsIamGroupPolicy) *AwsIamGroupDetails {
+ s.GroupPolicyList = v
+ return s
+}
- // The fully qualified domain name of the Active Directory domain.
- Fqdn *string `type:"string"`
+// SetPath sets the Path field's value.
+func (s *AwsIamGroupDetails) SetPath(v string) *AwsIamGroupDetails {
+ s.Path = &v
+ return s
+}
- // The name of the IAM role to use when making API calls to the Directory Service.
- IamRoleName *string `type:"string"`
+// A managed policy that is attached to the IAM group.
+type AwsIamGroupPolicy struct {
+ _ struct{} `type:"structure"`
- // The status of the Active Directory Domain membership for the DB instance.
- Status *string `type:"string"`
+ // The name of the policy.
+ PolicyName *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbDomainMembership) String() string {
+func (s AwsIamGroupPolicy) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbDomainMembership) GoString() string {
+func (s AwsIamGroupPolicy) GoString() string {
return s.String()
}
-// SetDomain sets the Domain field's value.
-func (s *AwsRdsDbDomainMembership) SetDomain(v string) *AwsRdsDbDomainMembership {
- s.Domain = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsIamGroupPolicy) SetPolicyName(v string) *AwsIamGroupPolicy {
+ s.PolicyName = &v
return s
}
-// SetFqdn sets the Fqdn field's value.
-func (s *AwsRdsDbDomainMembership) SetFqdn(v string) *AwsRdsDbDomainMembership {
- s.Fqdn = &v
- return s
-}
+// Information about an instance profile.
+type AwsIamInstanceProfile struct {
+ _ struct{} `type:"structure"`
-// SetIamRoleName sets the IamRoleName field's value.
-func (s *AwsRdsDbDomainMembership) SetIamRoleName(v string) *AwsRdsDbDomainMembership {
- s.IamRoleName = &v
- return s
-}
+ // The ARN of the instance profile.
+ Arn *string `type:"string"`
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbDomainMembership) SetStatus(v string) *AwsRdsDbDomainMembership {
- s.Status = &v
- return s
-}
+ // Indicates when the instance profile was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
-// An AWS Identity and Access Management (IAM) role associated with the DB instance.
-type AwsRdsDbInstanceAssociatedRole struct {
- _ struct{} `type:"structure"`
+ // The identifier of the instance profile.
+ InstanceProfileId *string `type:"string"`
- // The name of the feature associated with the IAM)role.
- FeatureName *string `type:"string"`
+ // The name of the instance profile.
+ InstanceProfileName *string `type:"string"`
- // The Amazon Resource Name (ARN) of the IAM role that is associated with the
- // DB instance.
- RoleArn *string `type:"string"`
+ // The path to the instance profile.
+ Path *string `type:"string"`
- // Describes the state of the association between the IAM role and the DB instance.
- // The Status property returns one of the following values:
- //
- // * ACTIVE - The IAM role ARN is associated with the DB instance and can
- // be used to access other AWS services on your behalf.
- //
- // * PENDING - The IAM role ARN is being associated with the DB instance.
- //
- // * INVALID - The IAM role ARN is associated with the DB instance. But the
- // DB instance is unable to assume the IAM role in order to access other
- // AWS services on your behalf.
- Status *string `type:"string"`
+ // The roles associated with the instance profile.
+ Roles []*AwsIamInstanceProfileRole `type:"list"`
}
// String returns the string representation
-func (s AwsRdsDbInstanceAssociatedRole) String() string {
+func (s AwsIamInstanceProfile) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbInstanceAssociatedRole) GoString() string {
+func (s AwsIamInstanceProfile) GoString() string {
return s.String()
}
-// SetFeatureName sets the FeatureName field's value.
-func (s *AwsRdsDbInstanceAssociatedRole) SetFeatureName(v string) *AwsRdsDbInstanceAssociatedRole {
- s.FeatureName = &v
- return s
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AwsIamInstanceProfile) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AwsIamInstanceProfile"}
+ if s.Roles != nil {
+ for i, v := range s.Roles {
+ if v == nil {
+ continue
+ }
+ if err := v.Validate(); err != nil {
+ invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Roles", i), err.(request.ErrInvalidParams))
+ }
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
}
-// SetRoleArn sets the RoleArn field's value.
-func (s *AwsRdsDbInstanceAssociatedRole) SetRoleArn(v string) *AwsRdsDbInstanceAssociatedRole {
- s.RoleArn = &v
+// SetArn sets the Arn field's value.
+func (s *AwsIamInstanceProfile) SetArn(v string) *AwsIamInstanceProfile {
+ s.Arn = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbInstanceAssociatedRole) SetStatus(v string) *AwsRdsDbInstanceAssociatedRole {
- s.Status = &v
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamInstanceProfile) SetCreateDate(v string) *AwsIamInstanceProfile {
+ s.CreateDate = &v
return s
}
-// Contains the details of an Amazon RDS DB instance.
-type AwsRdsDbInstanceDetails struct {
- _ struct{} `type:"structure"`
+// SetInstanceProfileId sets the InstanceProfileId field's value.
+func (s *AwsIamInstanceProfile) SetInstanceProfileId(v string) *AwsIamInstanceProfile {
+ s.InstanceProfileId = &v
+ return s
+}
- // The amount of storage (in gigabytes) to initially allocate for the DB instance.
- AllocatedStorage *int64 `type:"integer"`
+// SetInstanceProfileName sets the InstanceProfileName field's value.
+func (s *AwsIamInstanceProfile) SetInstanceProfileName(v string) *AwsIamInstanceProfile {
+ s.InstanceProfileName = &v
+ return s
+}
- // The AWS Identity and Access Management (IAM) roles associated with the DB
- // instance.
- AssociatedRoles []*AwsRdsDbInstanceAssociatedRole `type:"list"`
+// SetPath sets the Path field's value.
+func (s *AwsIamInstanceProfile) SetPath(v string) *AwsIamInstanceProfile {
+ s.Path = &v
+ return s
+}
- // Indicates whether minor version patches are applied automatically.
- AutoMinorVersionUpgrade *bool `type:"boolean"`
+// SetRoles sets the Roles field's value.
+func (s *AwsIamInstanceProfile) SetRoles(v []*AwsIamInstanceProfileRole) *AwsIamInstanceProfile {
+ s.Roles = v
+ return s
+}
- // The Availability Zone where the DB instance will be created.
- AvailabilityZone *string `type:"string"`
+// Information about a role associated with an instance profile.
+type AwsIamInstanceProfileRole struct {
+ _ struct{} `type:"structure"`
- // The number of days for which to retain automated backups.
- BackupRetentionPeriod *int64 `type:"integer"`
+ // The ARN of the role.
+ Arn *string `type:"string"`
- // The identifier of the CA certificate for this DB instance.
- CACertificateIdentifier *string `type:"string"`
+ // The policy that grants an entity permission to assume the role.
+ AssumeRolePolicyDocument *string `min:"1" type:"string"`
- // The name of the character set that this DB instance is associated with.
- CharacterSetName *string `type:"string"`
+ // Indicates when the role was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
- // Whether to copy resource tags to snapshots of the DB instance.
- CopyTagsToSnapshot *bool `type:"boolean"`
+ // The path to the role.
+ Path *string `type:"string"`
- // If the DB instance is a member of a DB cluster, contains the name of the
- // DB cluster that the DB instance is a member of.
- DBClusterIdentifier *string `type:"string"`
+ // The identifier of the role.
+ RoleId *string `type:"string"`
- // Contains the name of the compute and memory capacity class of the DB instance.
- DBInstanceClass *string `type:"string"`
+ // The name of the role.
+ RoleName *string `type:"string"`
+}
- // Contains a user-supplied database identifier. This identifier is the unique
- // key that identifies a DB instance.
- DBInstanceIdentifier *string `type:"string"`
+// String returns the string representation
+func (s AwsIamInstanceProfileRole) String() string {
+ return awsutil.Prettify(s)
+}
- // The meaning of this parameter differs according to the database engine you
- // use.
- //
- // MySQL, MariaDB, SQL Server, PostgreSQL
- //
- // Contains the name of the initial database of this instance that was provided
- // at create time, if one was specified when the DB instance was created. This
- // same name is returned for the life of the DB instance.
- //
- // Oracle
- //
- // Contains the Oracle System ID (SID) of the created DB instance. Not shown
- // when the returned parameters do not apply to an Oracle DB instance.
- DBName *string `type:"string"`
+// GoString returns the string representation
+func (s AwsIamInstanceProfileRole) GoString() string {
+ return s.String()
+}
- // Specifies the port that the DB instance listens on. If the DB instance is
- // part of a DB cluster, this can be a different port than the DB cluster port.
- DbInstancePort *int64 `type:"integer"`
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AwsIamInstanceProfileRole) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AwsIamInstanceProfileRole"}
+ if s.AssumeRolePolicyDocument != nil && len(*s.AssumeRolePolicyDocument) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("AssumeRolePolicyDocument", 1))
+ }
- // The current status of the DB instance.
- DbInstanceStatus *string `type:"string"`
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
+}
- // A list of the DB parameter groups to assign to the DB instance.
- DbParameterGroups []*AwsRdsDbParameterGroup `type:"list"`
+// SetArn sets the Arn field's value.
+func (s *AwsIamInstanceProfileRole) SetArn(v string) *AwsIamInstanceProfileRole {
+ s.Arn = &v
+ return s
+}
- // A list of the DB security groups to assign to the DB instance.
- DbSecurityGroups []*string `type:"list"`
+// SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.
+func (s *AwsIamInstanceProfileRole) SetAssumeRolePolicyDocument(v string) *AwsIamInstanceProfileRole {
+ s.AssumeRolePolicyDocument = &v
+ return s
+}
- // Information about the subnet group that is associated with the DB instance.
- DbSubnetGroup *AwsRdsDbSubnetGroup `type:"structure"`
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamInstanceProfileRole) SetCreateDate(v string) *AwsIamInstanceProfileRole {
+ s.CreateDate = &v
+ return s
+}
- // The AWS Region-unique, immutable identifier for the DB instance. This identifier
- // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB
- // instance is accessed.
- DbiResourceId *string `type:"string"`
+// SetPath sets the Path field's value.
+func (s *AwsIamInstanceProfileRole) SetPath(v string) *AwsIamInstanceProfileRole {
+ s.Path = &v
+ return s
+}
- // Indicates whether the DB instance has deletion protection enabled.
- //
- // When deletion protection is enabled, the database cannot be deleted.
- DeletionProtection *bool `type:"boolean"`
+// SetRoleId sets the RoleId field's value.
+func (s *AwsIamInstanceProfileRole) SetRoleId(v string) *AwsIamInstanceProfileRole {
+ s.RoleId = &v
+ return s
+}
- // The Active Directory domain membership records associated with the DB instance.
- DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`
+// SetRoleName sets the RoleName field's value.
+func (s *AwsIamInstanceProfileRole) SetRoleName(v string) *AwsIamInstanceProfileRole {
+ s.RoleName = &v
+ return s
+}
- // A list of log types that this DB instance is configured to export to CloudWatch
- // Logs.
- EnabledCloudWatchLogsExports []*string `type:"list"`
+// Information about the policy used to set the permissions boundary for an
+// IAM principal.
+type AwsIamPermissionsBoundary struct {
+ _ struct{} `type:"structure"`
- // Specifies the connection endpoint.
- Endpoint *AwsRdsDbInstanceEndpoint `type:"structure"`
+ // The ARN of the policy used to set the permissions boundary.
+ PermissionsBoundaryArn *string `type:"string"`
- // Provides the name of the database engine to use for this DB instance.
- Engine *string `type:"string"`
+ // The usage type for the permissions boundary.
+ PermissionsBoundaryType *string `type:"string"`
+}
- // Indicates the database engine version.
- EngineVersion *string `type:"string"`
+// String returns the string representation
+func (s AwsIamPermissionsBoundary) String() string {
+ return awsutil.Prettify(s)
+}
- // The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring
- // metrics data for the DB instance.
- EnhancedMonitoringResourceArn *string `type:"string"`
+// GoString returns the string representation
+func (s AwsIamPermissionsBoundary) GoString() string {
+ return s.String()
+}
- // True if mapping of AWS Identity and Access Management (IAM) accounts to database
- // accounts is enabled, and otherwise false.
- //
- // IAM database authentication can be enabled for the following database engines.
- //
- // * For MySQL 5.6, minor version 5.6.34 or higher
- //
- // * For MySQL 5.7, minor version 5.7.16 or higher
- //
- // * Aurora 5.6 or higher
- IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`
+// SetPermissionsBoundaryArn sets the PermissionsBoundaryArn field's value.
+func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryArn(v string) *AwsIamPermissionsBoundary {
+ s.PermissionsBoundaryArn = &v
+ return s
+}
- // Indicates when the DB instance was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- InstanceCreateTime *string `type:"string"`
+// SetPermissionsBoundaryType sets the PermissionsBoundaryType field's value.
+func (s *AwsIamPermissionsBoundary) SetPermissionsBoundaryType(v string) *AwsIamPermissionsBoundary {
+ s.PermissionsBoundaryType = &v
+ return s
+}
- // Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
- Iops *int64 `type:"integer"`
+// Represents an IAM permissions policy.
+type AwsIamPolicyDetails struct {
+ _ struct{} `type:"structure"`
- // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted
- // DB instance.
- KmsKeyId *string `type:"string"`
+ // The number of users, groups, and roles that the policy is attached to.
+ AttachmentCount *int64 `type:"integer"`
- // Specifies the latest time to which a database can be restored with point-in-time
- // restore.
+ // When the policy was created.
//
// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
// contain spaces. For example, 2020-03-22T13:22:13.933Z.
- LatestRestorableTime *string `type:"string"`
+ CreateDate *string `type:"string"`
- // License model information for this DB instance.
- LicenseModel *string `type:"string"`
+ // The identifier of the default version of the policy.
+ DefaultVersionId *string `type:"string"`
- // Specifies the connection endpoint.
- ListenerEndpoint *AwsRdsDbInstanceEndpoint `type:"structure"`
+ // A description of the policy.
+ Description *string `type:"string"`
- // The master user name of the DB instance.
- MasterUsername *string `type:"string"`
+ // Whether the policy can be attached to a user, group, or role.
+ IsAttachable *bool `type:"boolean"`
- // The upper limit to which Amazon RDS can automatically scale the storage of
- // the DB instance.
- MaxAllocatedStorage *int64 `type:"integer"`
+ // The path to the policy.
+ Path *string `type:"string"`
- // The interval, in seconds, between points when enhanced monitoring metrics
- // are collected for the DB instance.
- MonitoringInterval *int64 `type:"integer"`
+ // The number of users and roles that use the policy to set the permissions
+ // boundary.
+ PermissionsBoundaryUsageCount *int64 `type:"integer"`
- // The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring
- // metrics to CloudWatch Logs.
- MonitoringRoleArn *string `type:"string"`
+ // The unique identifier of the policy.
+ PolicyId *string `type:"string"`
- // Whether the DB instance is a multiple Availability Zone deployment.
- MultiAz *bool `type:"boolean"`
+ // The name of the policy.
+ PolicyName *string `type:"string"`
- // The list of option group memberships for this DB instance.
- OptionGroupMemberships []*AwsRdsDbOptionGroupMembership `type:"list"`
+ // List of versions of the policy.
+ PolicyVersionList []*AwsIamPolicyVersion `type:"list"`
- // Changes to the DB instance that are currently pending.
- PendingModifiedValues *AwsRdsDbPendingModifiedValues `type:"structure"`
+ // When the policy was most recently updated.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ UpdateDate *string `type:"string"`
+}
- // Indicates whether Performance Insights is enabled for the DB instance.
- PerformanceInsightsEnabled *bool `type:"boolean"`
+// String returns the string representation
+func (s AwsIamPolicyDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // The identifier of the AWS KMS key used to encrypt the Performance Insights
- // data.
- PerformanceInsightsKmsKeyId *string `type:"string"`
+// GoString returns the string representation
+func (s AwsIamPolicyDetails) GoString() string {
+ return s.String()
+}
- // The number of days to retain Performance Insights data.
- PerformanceInsightsRetentionPeriod *int64 `type:"integer"`
+// SetAttachmentCount sets the AttachmentCount field's value.
+func (s *AwsIamPolicyDetails) SetAttachmentCount(v int64) *AwsIamPolicyDetails {
+ s.AttachmentCount = &v
+ return s
+}
- // The range of time each day when automated backups are created, if automated
- // backups are enabled.
- //
- // Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
- PreferredBackupWindow *string `type:"string"`
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamPolicyDetails) SetCreateDate(v string) *AwsIamPolicyDetails {
+ s.CreateDate = &v
+ return s
+}
- // The weekly time range during which system maintenance can occur, in Universal
- // Coordinated Time (UTC).
- //
- // Uses the format :HH:MM-:HH:MM.
- //
- // For the day values, use mon|tue|wed|thu|fri|sat|sun.
- //
- // For example, sun:09:32-sun:10:02.
- PreferredMaintenanceWindow *string `type:"string"`
+// SetDefaultVersionId sets the DefaultVersionId field's value.
+func (s *AwsIamPolicyDetails) SetDefaultVersionId(v string) *AwsIamPolicyDetails {
+ s.DefaultVersionId = &v
+ return s
+}
- // The number of CPU cores and the number of threads per core for the DB instance
- // class of the DB instance.
- ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
+// SetDescription sets the Description field's value.
+func (s *AwsIamPolicyDetails) SetDescription(v string) *AwsIamPolicyDetails {
+ s.Description = &v
+ return s
+}
- // The order in which to promote an Aurora replica to the primary instance after
- // a failure of the existing primary instance.
- PromotionTier *int64 `type:"integer"`
+// SetIsAttachable sets the IsAttachable field's value.
+func (s *AwsIamPolicyDetails) SetIsAttachable(v bool) *AwsIamPolicyDetails {
+ s.IsAttachable = &v
+ return s
+}
- // Specifies the accessibility options for the DB instance.
- //
- // A value of true specifies an Internet-facing instance with a publicly resolvable
- // DNS name, which resolves to a public IP address.
- //
- // A value of false specifies an internal instance with a DNS name that resolves
- // to a private IP address.
- PubliclyAccessible *bool `type:"boolean"`
-
- // List of identifiers of Aurora DB clusters to which the RDS DB instance is
- // replicated as a read replica.
- ReadReplicaDBClusterIdentifiers []*string `type:"list"`
+// SetPath sets the Path field's value.
+func (s *AwsIamPolicyDetails) SetPath(v string) *AwsIamPolicyDetails {
+ s.Path = &v
+ return s
+}
- // List of identifiers of the read replicas associated with this DB instance.
- ReadReplicaDBInstanceIdentifiers []*string `type:"list"`
+// SetPermissionsBoundaryUsageCount sets the PermissionsBoundaryUsageCount field's value.
+func (s *AwsIamPolicyDetails) SetPermissionsBoundaryUsageCount(v int64) *AwsIamPolicyDetails {
+ s.PermissionsBoundaryUsageCount = &v
+ return s
+}
- // If this DB instance is a read replica, contains the identifier of the source
- // DB instance.
- ReadReplicaSourceDBInstanceIdentifier *string `type:"string"`
+// SetPolicyId sets the PolicyId field's value.
+func (s *AwsIamPolicyDetails) SetPolicyId(v string) *AwsIamPolicyDetails {
+ s.PolicyId = &v
+ return s
+}
- // For a DB instance with multi-Availability Zone support, the name of the secondary
- // Availability Zone.
- SecondaryAvailabilityZone *string `type:"string"`
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsIamPolicyDetails) SetPolicyName(v string) *AwsIamPolicyDetails {
+ s.PolicyName = &v
+ return s
+}
- // The status of a read replica. If the instance isn't a read replica, this
- // is empty.
- StatusInfos []*AwsRdsDbStatusInfo `type:"list"`
+// SetPolicyVersionList sets the PolicyVersionList field's value.
+func (s *AwsIamPolicyDetails) SetPolicyVersionList(v []*AwsIamPolicyVersion) *AwsIamPolicyDetails {
+ s.PolicyVersionList = v
+ return s
+}
- // Specifies whether the DB instance is encrypted.
- StorageEncrypted *bool `type:"boolean"`
+// SetUpdateDate sets the UpdateDate field's value.
+func (s *AwsIamPolicyDetails) SetUpdateDate(v string) *AwsIamPolicyDetails {
+ s.UpdateDate = &v
+ return s
+}
- // The storage type for the DB instance.
- StorageType *string `type:"string"`
+// A version of an IAM policy.
+type AwsIamPolicyVersion struct {
+ _ struct{} `type:"structure"`
- // The ARN from the key store with which the instance is associated for TDE
- // encryption.
- TdeCredentialArn *string `type:"string"`
+ // Indicates when the version was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
- // The time zone of the DB instance.
- Timezone *string `type:"string"`
+ // Whether the version is the default version.
+ IsDefaultVersion *bool `type:"boolean"`
- // A list of VPC security groups that the DB instance belongs to.
- VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
+ // The identifier of the policy version.
+ VersionId *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbInstanceDetails) String() string {
+func (s AwsIamPolicyVersion) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbInstanceDetails) GoString() string {
+func (s AwsIamPolicyVersion) GoString() string {
return s.String()
}
-// SetAllocatedStorage sets the AllocatedStorage field's value.
-func (s *AwsRdsDbInstanceDetails) SetAllocatedStorage(v int64) *AwsRdsDbInstanceDetails {
- s.AllocatedStorage = &v
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamPolicyVersion) SetCreateDate(v string) *AwsIamPolicyVersion {
+ s.CreateDate = &v
return s
}
-// SetAssociatedRoles sets the AssociatedRoles field's value.
-func (s *AwsRdsDbInstanceDetails) SetAssociatedRoles(v []*AwsRdsDbInstanceAssociatedRole) *AwsRdsDbInstanceDetails {
- s.AssociatedRoles = v
+// SetIsDefaultVersion sets the IsDefaultVersion field's value.
+func (s *AwsIamPolicyVersion) SetIsDefaultVersion(v bool) *AwsIamPolicyVersion {
+ s.IsDefaultVersion = &v
return s
}
-// SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.
-func (s *AwsRdsDbInstanceDetails) SetAutoMinorVersionUpgrade(v bool) *AwsRdsDbInstanceDetails {
- s.AutoMinorVersionUpgrade = &v
+// SetVersionId sets the VersionId field's value.
+func (s *AwsIamPolicyVersion) SetVersionId(v string) *AwsIamPolicyVersion {
+ s.VersionId = &v
return s
}
-// SetAvailabilityZone sets the AvailabilityZone field's value.
-func (s *AwsRdsDbInstanceDetails) SetAvailabilityZone(v string) *AwsRdsDbInstanceDetails {
- s.AvailabilityZone = &v
- return s
-}
+// Contains information about an IAM role, including all of the role's policies.
+type AwsIamRoleDetails struct {
+ _ struct{} `type:"structure"`
-// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
-func (s *AwsRdsDbInstanceDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbInstanceDetails {
- s.BackupRetentionPeriod = &v
- return s
-}
+ // The trust policy that grants permission to assume the role.
+ AssumeRolePolicyDocument *string `min:"1" type:"string"`
-// SetCACertificateIdentifier sets the CACertificateIdentifier field's value.
-func (s *AwsRdsDbInstanceDetails) SetCACertificateIdentifier(v string) *AwsRdsDbInstanceDetails {
- s.CACertificateIdentifier = &v
- return s
-}
+ // The list of the managed policies that are attached to the role.
+ AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
-// SetCharacterSetName sets the CharacterSetName field's value.
-func (s *AwsRdsDbInstanceDetails) SetCharacterSetName(v string) *AwsRdsDbInstanceDetails {
- s.CharacterSetName = &v
- return s
+ // Indicates when the role was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
+
+ // The list of instance profiles that contain this role.
+ InstanceProfileList []*AwsIamInstanceProfile `type:"list"`
+
+ // The maximum session duration (in seconds) that you want to set for the specified
+ // role.
+ MaxSessionDuration *int64 `type:"integer"`
+
+ // The path to the role.
+ Path *string `type:"string"`
+
+ // Information about the policy used to set the permissions boundary for an
+ // IAM principal.
+ PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`
+
+ // The stable and unique string identifying the role.
+ RoleId *string `type:"string"`
+
+ // The friendly name that identifies the role.
+ RoleName *string `type:"string"`
+
+ // The list of inline policies that are embedded in the role.
+ RolePolicyList []*AwsIamRolePolicy `type:"list"`
}
-// SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.
-func (s *AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbInstanceDetails {
- s.CopyTagsToSnapshot = &v
- return s
+// String returns the string representation
+func (s AwsIamRoleDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetDBClusterIdentifier sets the DBClusterIdentifier field's value.
-func (s *AwsRdsDbInstanceDetails) SetDBClusterIdentifier(v string) *AwsRdsDbInstanceDetails {
- s.DBClusterIdentifier = &v
- return s
+// GoString returns the string representation
+func (s AwsIamRoleDetails) GoString() string {
+ return s.String()
}
-// SetDBInstanceClass sets the DBInstanceClass field's value.
-func (s *AwsRdsDbInstanceDetails) SetDBInstanceClass(v string) *AwsRdsDbInstanceDetails {
- s.DBInstanceClass = &v
- return s
+// Validate inspects the fields of the type to determine if they are valid.
+func (s *AwsIamRoleDetails) Validate() error {
+ invalidParams := request.ErrInvalidParams{Context: "AwsIamRoleDetails"}
+ if s.AssumeRolePolicyDocument != nil && len(*s.AssumeRolePolicyDocument) < 1 {
+ invalidParams.Add(request.NewErrParamMinLen("AssumeRolePolicyDocument", 1))
+ }
+ if s.InstanceProfileList != nil {
+ for i, v := range s.InstanceProfileList {
+ if v == nil {
+ continue
+ }
+ if err := v.Validate(); err != nil {
+ invalidParams.AddNested(fmt.Sprintf("%s[%v]", "InstanceProfileList", i), err.(request.ErrInvalidParams))
+ }
+ }
+ }
+
+ if invalidParams.Len() > 0 {
+ return invalidParams
+ }
+ return nil
}
-// SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.
-func (s *AwsRdsDbInstanceDetails) SetDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails {
- s.DBInstanceIdentifier = &v
+// SetAssumeRolePolicyDocument sets the AssumeRolePolicyDocument field's value.
+func (s *AwsIamRoleDetails) SetAssumeRolePolicyDocument(v string) *AwsIamRoleDetails {
+ s.AssumeRolePolicyDocument = &v
return s
}
-// SetDBName sets the DBName field's value.
-func (s *AwsRdsDbInstanceDetails) SetDBName(v string) *AwsRdsDbInstanceDetails {
- s.DBName = &v
+// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
+func (s *AwsIamRoleDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamRoleDetails {
+ s.AttachedManagedPolicies = v
return s
}
-// SetDbInstancePort sets the DbInstancePort field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbInstancePort(v int64) *AwsRdsDbInstanceDetails {
- s.DbInstancePort = &v
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamRoleDetails) SetCreateDate(v string) *AwsIamRoleDetails {
+ s.CreateDate = &v
return s
}
-// SetDbInstanceStatus sets the DbInstanceStatus field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbInstanceStatus(v string) *AwsRdsDbInstanceDetails {
- s.DbInstanceStatus = &v
+// SetInstanceProfileList sets the InstanceProfileList field's value.
+func (s *AwsIamRoleDetails) SetInstanceProfileList(v []*AwsIamInstanceProfile) *AwsIamRoleDetails {
+ s.InstanceProfileList = v
return s
}
-// SetDbParameterGroups sets the DbParameterGroups field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbParameterGroups(v []*AwsRdsDbParameterGroup) *AwsRdsDbInstanceDetails {
- s.DbParameterGroups = v
+// SetMaxSessionDuration sets the MaxSessionDuration field's value.
+func (s *AwsIamRoleDetails) SetMaxSessionDuration(v int64) *AwsIamRoleDetails {
+ s.MaxSessionDuration = &v
return s
}
-// SetDbSecurityGroups sets the DbSecurityGroups field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbSecurityGroups(v []*string) *AwsRdsDbInstanceDetails {
- s.DbSecurityGroups = v
+// SetPath sets the Path field's value.
+func (s *AwsIamRoleDetails) SetPath(v string) *AwsIamRoleDetails {
+ s.Path = &v
return s
}
-// SetDbSubnetGroup sets the DbSubnetGroup field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbSubnetGroup(v *AwsRdsDbSubnetGroup) *AwsRdsDbInstanceDetails {
- s.DbSubnetGroup = v
+// SetPermissionsBoundary sets the PermissionsBoundary field's value.
+func (s *AwsIamRoleDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamRoleDetails {
+ s.PermissionsBoundary = v
return s
}
-// SetDbiResourceId sets the DbiResourceId field's value.
-func (s *AwsRdsDbInstanceDetails) SetDbiResourceId(v string) *AwsRdsDbInstanceDetails {
- s.DbiResourceId = &v
+// SetRoleId sets the RoleId field's value.
+func (s *AwsIamRoleDetails) SetRoleId(v string) *AwsIamRoleDetails {
+ s.RoleId = &v
return s
}
-// SetDeletionProtection sets the DeletionProtection field's value.
-func (s *AwsRdsDbInstanceDetails) SetDeletionProtection(v bool) *AwsRdsDbInstanceDetails {
- s.DeletionProtection = &v
+// SetRoleName sets the RoleName field's value.
+func (s *AwsIamRoleDetails) SetRoleName(v string) *AwsIamRoleDetails {
+ s.RoleName = &v
return s
}
-// SetDomainMemberships sets the DomainMemberships field's value.
-func (s *AwsRdsDbInstanceDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbInstanceDetails {
- s.DomainMemberships = v
+// SetRolePolicyList sets the RolePolicyList field's value.
+func (s *AwsIamRoleDetails) SetRolePolicyList(v []*AwsIamRolePolicy) *AwsIamRoleDetails {
+ s.RolePolicyList = v
return s
}
-// SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.
-func (s *AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbInstanceDetails {
- s.EnabledCloudWatchLogsExports = v
- return s
-}
+// An inline policy that is embedded in the role.
+type AwsIamRolePolicy struct {
+ _ struct{} `type:"structure"`
-// SetEndpoint sets the Endpoint field's value.
-func (s *AwsRdsDbInstanceDetails) SetEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails {
- s.Endpoint = v
- return s
+ // The name of the policy.
+ PolicyName *string `type:"string"`
}
-// SetEngine sets the Engine field's value.
-func (s *AwsRdsDbInstanceDetails) SetEngine(v string) *AwsRdsDbInstanceDetails {
- s.Engine = &v
- return s
+// String returns the string representation
+func (s AwsIamRolePolicy) String() string {
+ return awsutil.Prettify(s)
}
-// SetEngineVersion sets the EngineVersion field's value.
-func (s *AwsRdsDbInstanceDetails) SetEngineVersion(v string) *AwsRdsDbInstanceDetails {
- s.EngineVersion = &v
- return s
+// GoString returns the string representation
+func (s AwsIamRolePolicy) GoString() string {
+ return s.String()
}
-// SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.
-func (s *AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn(v string) *AwsRdsDbInstanceDetails {
- s.EnhancedMonitoringResourceArn = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsIamRolePolicy) SetPolicyName(v string) *AwsIamRolePolicy {
+ s.PolicyName = &v
return s
}
-// SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.
-func (s *AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled(v bool) *AwsRdsDbInstanceDetails {
- s.IAMDatabaseAuthenticationEnabled = &v
- return s
+// Information about an IAM user.
+type AwsIamUserDetails struct {
+ _ struct{} `type:"structure"`
+
+ // A list of the managed policies that are attached to the user.
+ AttachedManagedPolicies []*AwsIamAttachedManagedPolicy `type:"list"`
+
+ // Indicates when the user was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreateDate *string `type:"string"`
+
+ // A list of IAM groups that the user belongs to.
+ GroupList []*string `type:"list"`
+
+ // The path to the user.
+ Path *string `type:"string"`
+
+ // The permissions boundary for the user.
+ PermissionsBoundary *AwsIamPermissionsBoundary `type:"structure"`
+
+ // The unique identifier for the user.
+ UserId *string `type:"string"`
+
+ // The name of the user.
+ UserName *string `type:"string"`
+
+ // The list of inline policies that are embedded in the user.
+ UserPolicyList []*AwsIamUserPolicy `type:"list"`
}
-// SetInstanceCreateTime sets the InstanceCreateTime field's value.
-func (s *AwsRdsDbInstanceDetails) SetInstanceCreateTime(v string) *AwsRdsDbInstanceDetails {
- s.InstanceCreateTime = &v
- return s
+// String returns the string representation
+func (s AwsIamUserDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetIops sets the Iops field's value.
-func (s *AwsRdsDbInstanceDetails) SetIops(v int64) *AwsRdsDbInstanceDetails {
- s.Iops = &v
- return s
+// GoString returns the string representation
+func (s AwsIamUserDetails) GoString() string {
+ return s.String()
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsRdsDbInstanceDetails) SetKmsKeyId(v string) *AwsRdsDbInstanceDetails {
- s.KmsKeyId = &v
+// SetAttachedManagedPolicies sets the AttachedManagedPolicies field's value.
+func (s *AwsIamUserDetails) SetAttachedManagedPolicies(v []*AwsIamAttachedManagedPolicy) *AwsIamUserDetails {
+ s.AttachedManagedPolicies = v
return s
}
-// SetLatestRestorableTime sets the LatestRestorableTime field's value.
-func (s *AwsRdsDbInstanceDetails) SetLatestRestorableTime(v string) *AwsRdsDbInstanceDetails {
- s.LatestRestorableTime = &v
+// SetCreateDate sets the CreateDate field's value.
+func (s *AwsIamUserDetails) SetCreateDate(v string) *AwsIamUserDetails {
+ s.CreateDate = &v
return s
}
-// SetLicenseModel sets the LicenseModel field's value.
-func (s *AwsRdsDbInstanceDetails) SetLicenseModel(v string) *AwsRdsDbInstanceDetails {
- s.LicenseModel = &v
+// SetGroupList sets the GroupList field's value.
+func (s *AwsIamUserDetails) SetGroupList(v []*string) *AwsIamUserDetails {
+ s.GroupList = v
return s
}
-// SetListenerEndpoint sets the ListenerEndpoint field's value.
-func (s *AwsRdsDbInstanceDetails) SetListenerEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails {
- s.ListenerEndpoint = v
+// SetPath sets the Path field's value.
+func (s *AwsIamUserDetails) SetPath(v string) *AwsIamUserDetails {
+ s.Path = &v
return s
}
-// SetMasterUsername sets the MasterUsername field's value.
-func (s *AwsRdsDbInstanceDetails) SetMasterUsername(v string) *AwsRdsDbInstanceDetails {
- s.MasterUsername = &v
+// SetPermissionsBoundary sets the PermissionsBoundary field's value.
+func (s *AwsIamUserDetails) SetPermissionsBoundary(v *AwsIamPermissionsBoundary) *AwsIamUserDetails {
+ s.PermissionsBoundary = v
return s
}
-// SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.
-func (s *AwsRdsDbInstanceDetails) SetMaxAllocatedStorage(v int64) *AwsRdsDbInstanceDetails {
- s.MaxAllocatedStorage = &v
+// SetUserId sets the UserId field's value.
+func (s *AwsIamUserDetails) SetUserId(v string) *AwsIamUserDetails {
+ s.UserId = &v
return s
}
-// SetMonitoringInterval sets the MonitoringInterval field's value.
-func (s *AwsRdsDbInstanceDetails) SetMonitoringInterval(v int64) *AwsRdsDbInstanceDetails {
- s.MonitoringInterval = &v
+// SetUserName sets the UserName field's value.
+func (s *AwsIamUserDetails) SetUserName(v string) *AwsIamUserDetails {
+ s.UserName = &v
return s
}
-// SetMonitoringRoleArn sets the MonitoringRoleArn field's value.
-func (s *AwsRdsDbInstanceDetails) SetMonitoringRoleArn(v string) *AwsRdsDbInstanceDetails {
- s.MonitoringRoleArn = &v
+// SetUserPolicyList sets the UserPolicyList field's value.
+func (s *AwsIamUserDetails) SetUserPolicyList(v []*AwsIamUserPolicy) *AwsIamUserDetails {
+ s.UserPolicyList = v
return s
}
-// SetMultiAz sets the MultiAz field's value.
-func (s *AwsRdsDbInstanceDetails) SetMultiAz(v bool) *AwsRdsDbInstanceDetails {
- s.MultiAz = &v
- return s
+// Information about an inline policy that is embedded in the user.
+type AwsIamUserPolicy struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the policy.
+ PolicyName *string `type:"string"`
}
-// SetOptionGroupMemberships sets the OptionGroupMemberships field's value.
-func (s *AwsRdsDbInstanceDetails) SetOptionGroupMemberships(v []*AwsRdsDbOptionGroupMembership) *AwsRdsDbInstanceDetails {
- s.OptionGroupMemberships = v
- return s
+// String returns the string representation
+func (s AwsIamUserPolicy) String() string {
+ return awsutil.Prettify(s)
}
-// SetPendingModifiedValues sets the PendingModifiedValues field's value.
-func (s *AwsRdsDbInstanceDetails) SetPendingModifiedValues(v *AwsRdsDbPendingModifiedValues) *AwsRdsDbInstanceDetails {
- s.PendingModifiedValues = v
- return s
+// GoString returns the string representation
+func (s AwsIamUserPolicy) GoString() string {
+ return s.String()
}
-// SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.
-func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled(v bool) *AwsRdsDbInstanceDetails {
- s.PerformanceInsightsEnabled = &v
+// SetPolicyName sets the PolicyName field's value.
+func (s *AwsIamUserPolicy) SetPolicyName(v string) *AwsIamUserPolicy {
+ s.PolicyName = &v
return s
}
-// SetPerformanceInsightsKmsKeyId sets the PerformanceInsightsKmsKeyId field's value.
-func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId(v string) *AwsRdsDbInstanceDetails {
- s.PerformanceInsightsKmsKeyId = &v
- return s
+// Contains metadata about a customer master key (CMK).
+type AwsKmsKeyDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The twelve-digit account ID of the AWS account that owns the CMK.
+ AWSAccountId *string `type:"string"`
+
+ // Indicates when the CMK was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreationDate *float64 `type:"double"`
+
+ // A description of the key.
+ Description *string `type:"string"`
+
+ // The globally unique identifier for the CMK.
+ KeyId *string `type:"string"`
+
+ // The manager of the CMK. CMKs in your AWS account are either customer managed
+ // or AWS managed.
+ KeyManager *string `type:"string"`
+
+ // The state of the CMK.
+ KeyState *string `type:"string"`
+
+ // The source of the CMK's key material.
+ //
+ // When this value is AWS_KMS, AWS KMS created the key material.
+ //
+ // When this value is EXTERNAL, the key material was imported from your existing
+ // key management infrastructure or the CMK lacks key material.
+ //
+ // When this value is AWS_CLOUDHSM, the key material was created in the AWS
+ // CloudHSM cluster associated with a custom key store.
+ Origin *string `type:"string"`
}
-// SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.
-func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod(v int64) *AwsRdsDbInstanceDetails {
- s.PerformanceInsightsRetentionPeriod = &v
- return s
+// String returns the string representation
+func (s AwsKmsKeyDetails) String() string {
+ return awsutil.Prettify(s)
}
-// SetPreferredBackupWindow sets the PreferredBackupWindow field's value.
-func (s *AwsRdsDbInstanceDetails) SetPreferredBackupWindow(v string) *AwsRdsDbInstanceDetails {
- s.PreferredBackupWindow = &v
- return s
+// GoString returns the string representation
+func (s AwsKmsKeyDetails) GoString() string {
+ return s.String()
}
-// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
-func (s *AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbInstanceDetails {
- s.PreferredMaintenanceWindow = &v
+// SetAWSAccountId sets the AWSAccountId field's value.
+func (s *AwsKmsKeyDetails) SetAWSAccountId(v string) *AwsKmsKeyDetails {
+ s.AWSAccountId = &v
return s
}
-// SetProcessorFeatures sets the ProcessorFeatures field's value.
-func (s *AwsRdsDbInstanceDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbInstanceDetails {
- s.ProcessorFeatures = v
+// SetCreationDate sets the CreationDate field's value.
+func (s *AwsKmsKeyDetails) SetCreationDate(v float64) *AwsKmsKeyDetails {
+ s.CreationDate = &v
return s
}
-// SetPromotionTier sets the PromotionTier field's value.
-func (s *AwsRdsDbInstanceDetails) SetPromotionTier(v int64) *AwsRdsDbInstanceDetails {
- s.PromotionTier = &v
+// SetDescription sets the Description field's value.
+func (s *AwsKmsKeyDetails) SetDescription(v string) *AwsKmsKeyDetails {
+ s.Description = &v
return s
}
-// SetPubliclyAccessible sets the PubliclyAccessible field's value.
-func (s *AwsRdsDbInstanceDetails) SetPubliclyAccessible(v bool) *AwsRdsDbInstanceDetails {
- s.PubliclyAccessible = &v
+// SetKeyId sets the KeyId field's value.
+func (s *AwsKmsKeyDetails) SetKeyId(v string) *AwsKmsKeyDetails {
+ s.KeyId = &v
return s
}
-// SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.
-func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers(v []*string) *AwsRdsDbInstanceDetails {
- s.ReadReplicaDBClusterIdentifiers = v
+// SetKeyManager sets the KeyManager field's value.
+func (s *AwsKmsKeyDetails) SetKeyManager(v string) *AwsKmsKeyDetails {
+ s.KeyManager = &v
return s
}
-// SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.
-func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers(v []*string) *AwsRdsDbInstanceDetails {
- s.ReadReplicaDBInstanceIdentifiers = v
+// SetKeyState sets the KeyState field's value.
+func (s *AwsKmsKeyDetails) SetKeyState(v string) *AwsKmsKeyDetails {
+ s.KeyState = &v
return s
}
-// SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.
-func (s *AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails {
- s.ReadReplicaSourceDBInstanceIdentifier = &v
+// SetOrigin sets the Origin field's value.
+func (s *AwsKmsKeyDetails) SetOrigin(v string) *AwsKmsKeyDetails {
+ s.Origin = &v
return s
}
-// SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.
-func (s *AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone(v string) *AwsRdsDbInstanceDetails {
- s.SecondaryAvailabilityZone = &v
- return s
+// The code for the Lambda function. You can specify either an object in Amazon
+// S3, or upload a deployment package directly.
+type AwsLambdaFunctionCode struct {
+ _ struct{} `type:"structure"`
+
+ // An Amazon S3 bucket in the same AWS Region as your function. The bucket can
+ // be in a different AWS account.
+ S3Bucket *string `type:"string"`
+
+ // The Amazon S3 key of the deployment package.
+ S3Key *string `type:"string"`
+
+ // For versioned objects, the version of the deployment package object to use.
+ S3ObjectVersion *string `type:"string"`
+
+ // The base64-encoded contents of the deployment package. AWS SDK and AWS CLI
+ // clients handle the encoding for you.
+ ZipFile *string `type:"string"`
}
-// SetStatusInfos sets the StatusInfos field's value.
-func (s *AwsRdsDbInstanceDetails) SetStatusInfos(v []*AwsRdsDbStatusInfo) *AwsRdsDbInstanceDetails {
- s.StatusInfos = v
- return s
+// String returns the string representation
+func (s AwsLambdaFunctionCode) String() string {
+ return awsutil.Prettify(s)
}
-// SetStorageEncrypted sets the StorageEncrypted field's value.
-func (s *AwsRdsDbInstanceDetails) SetStorageEncrypted(v bool) *AwsRdsDbInstanceDetails {
- s.StorageEncrypted = &v
- return s
+// GoString returns the string representation
+func (s AwsLambdaFunctionCode) GoString() string {
+ return s.String()
}
-// SetStorageType sets the StorageType field's value.
-func (s *AwsRdsDbInstanceDetails) SetStorageType(v string) *AwsRdsDbInstanceDetails {
- s.StorageType = &v
+// SetS3Bucket sets the S3Bucket field's value.
+func (s *AwsLambdaFunctionCode) SetS3Bucket(v string) *AwsLambdaFunctionCode {
+ s.S3Bucket = &v
return s
}
-// SetTdeCredentialArn sets the TdeCredentialArn field's value.
-func (s *AwsRdsDbInstanceDetails) SetTdeCredentialArn(v string) *AwsRdsDbInstanceDetails {
- s.TdeCredentialArn = &v
+// SetS3Key sets the S3Key field's value.
+func (s *AwsLambdaFunctionCode) SetS3Key(v string) *AwsLambdaFunctionCode {
+ s.S3Key = &v
return s
}
-// SetTimezone sets the Timezone field's value.
-func (s *AwsRdsDbInstanceDetails) SetTimezone(v string) *AwsRdsDbInstanceDetails {
- s.Timezone = &v
+// SetS3ObjectVersion sets the S3ObjectVersion field's value.
+func (s *AwsLambdaFunctionCode) SetS3ObjectVersion(v string) *AwsLambdaFunctionCode {
+ s.S3ObjectVersion = &v
return s
}
-// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
-func (s *AwsRdsDbInstanceDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbInstanceDetails {
- s.VpcSecurityGroups = v
+// SetZipFile sets the ZipFile field's value.
+func (s *AwsLambdaFunctionCode) SetZipFile(v string) *AwsLambdaFunctionCode {
+ s.ZipFile = &v
return s
}
-// Specifies the connection endpoint.
-type AwsRdsDbInstanceEndpoint struct {
+// The dead-letter queue for failed asynchronous invocations.
+type AwsLambdaFunctionDeadLetterConfig struct {
_ struct{} `type:"structure"`
- // Specifies the DNS address of the DB instance.
- Address *string `type:"string"`
-
- // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- HostedZoneId *string `type:"string"`
-
- // Specifies the port that the database engine is listening on.
- Port *int64 `type:"integer"`
+ // The ARN of an Amazon SQS queue or Amazon SNS topic.
+ TargetArn *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbInstanceEndpoint) String() string {
+func (s AwsLambdaFunctionDeadLetterConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbInstanceEndpoint) GoString() string {
+func (s AwsLambdaFunctionDeadLetterConfig) GoString() string {
return s.String()
}
-// SetAddress sets the Address field's value.
-func (s *AwsRdsDbInstanceEndpoint) SetAddress(v string) *AwsRdsDbInstanceEndpoint {
- s.Address = &v
+// SetTargetArn sets the TargetArn field's value.
+func (s *AwsLambdaFunctionDeadLetterConfig) SetTargetArn(v string) *AwsLambdaFunctionDeadLetterConfig {
+ s.TargetArn = &v
return s
}
-// SetHostedZoneId sets the HostedZoneId field's value.
-func (s *AwsRdsDbInstanceEndpoint) SetHostedZoneId(v string) *AwsRdsDbInstanceEndpoint {
- s.HostedZoneId = &v
- return s
-}
+// Details about a function's configuration.
+type AwsLambdaFunctionDetails struct {
+ _ struct{} `type:"structure"`
-// SetPort sets the Port field's value.
-func (s *AwsRdsDbInstanceEndpoint) SetPort(v int64) *AwsRdsDbInstanceEndpoint {
- s.Port = &v
- return s
-}
+ // An AwsLambdaFunctionCode object.
+ Code *AwsLambdaFunctionCode `type:"structure"`
-// A VPC security groups that the DB instance belongs to.
-type AwsRdsDbInstanceVpcSecurityGroup struct {
- _ struct{} `type:"structure"`
+ // The SHA256 hash of the function's deployment package.
+ CodeSha256 *string `type:"string"`
- // The status of the VPC security group.
- Status *string `type:"string"`
+ // The function's dead letter queue.
+ DeadLetterConfig *AwsLambdaFunctionDeadLetterConfig `type:"structure"`
- // The name of the VPC security group.
- VpcSecurityGroupId *string `type:"string"`
+ // The function's environment variables.
+ Environment *AwsLambdaFunctionEnvironment `type:"structure"`
+
+ // The name of the function.
+ FunctionName *string `type:"string"`
+
+ // The function that Lambda calls to begin executing your function.
+ Handler *string `type:"string"`
+
+ // The KMS key that's used to encrypt the function's environment variables.
+ // This key is only returned if you've configured a customer managed CMK.
+ KmsKeyArn *string `type:"string"`
+
+ // Indicates when the function was last updated.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ LastModified *string `type:"string"`
+
+ // The function's layers.
+ Layers []*AwsLambdaFunctionLayer `type:"list"`
+
+ // For Lambda@Edge functions, the ARN of the master function.
+ MasterArn *string `type:"string"`
+
+ // The memory that is allocated to the function.
+ MemorySize *int64 `type:"integer"`
+
+ // The latest updated revision of the function or alias.
+ RevisionId *string `type:"string"`
+
+ // The function's execution role.
+ Role *string `type:"string"`
+
+ // The runtime environment for the Lambda function.
+ Runtime *string `type:"string"`
+
+ // The amount of time that Lambda allows a function to run before stopping it.
+ Timeout *int64 `type:"integer"`
+
+ // The function's AWS X-Ray tracing configuration.
+ TracingConfig *AwsLambdaFunctionTracingConfig `type:"structure"`
+
+ // The version of the Lambda function.
+ Version *string `type:"string"`
+
+ // The function's networking configuration.
+ VpcConfig *AwsLambdaFunctionVpcConfig `type:"structure"`
}
// String returns the string representation
-func (s AwsRdsDbInstanceVpcSecurityGroup) String() string {
+func (s AwsLambdaFunctionDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbInstanceVpcSecurityGroup) GoString() string {
+func (s AwsLambdaFunctionDetails) GoString() string {
return s.String()
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbInstanceVpcSecurityGroup) SetStatus(v string) *AwsRdsDbInstanceVpcSecurityGroup {
- s.Status = &v
+// SetCode sets the Code field's value.
+func (s *AwsLambdaFunctionDetails) SetCode(v *AwsLambdaFunctionCode) *AwsLambdaFunctionDetails {
+ s.Code = v
return s
}
-// SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.
-func (s *AwsRdsDbInstanceVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRdsDbInstanceVpcSecurityGroup {
- s.VpcSecurityGroupId = &v
+// SetCodeSha256 sets the CodeSha256 field's value.
+func (s *AwsLambdaFunctionDetails) SetCodeSha256(v string) *AwsLambdaFunctionDetails {
+ s.CodeSha256 = &v
return s
}
-// An option group membership.
-type AwsRdsDbOptionGroupMembership struct {
- _ struct{} `type:"structure"`
-
- // The name of the option group.
- OptionGroupName *string `type:"string"`
-
- // The status of the option group membership.
- Status *string `type:"string"`
+// SetDeadLetterConfig sets the DeadLetterConfig field's value.
+func (s *AwsLambdaFunctionDetails) SetDeadLetterConfig(v *AwsLambdaFunctionDeadLetterConfig) *AwsLambdaFunctionDetails {
+ s.DeadLetterConfig = v
+ return s
}
-// String returns the string representation
-func (s AwsRdsDbOptionGroupMembership) String() string {
- return awsutil.Prettify(s)
+// SetEnvironment sets the Environment field's value.
+func (s *AwsLambdaFunctionDetails) SetEnvironment(v *AwsLambdaFunctionEnvironment) *AwsLambdaFunctionDetails {
+ s.Environment = v
+ return s
}
-// GoString returns the string representation
-func (s AwsRdsDbOptionGroupMembership) GoString() string {
- return s.String()
+// SetFunctionName sets the FunctionName field's value.
+func (s *AwsLambdaFunctionDetails) SetFunctionName(v string) *AwsLambdaFunctionDetails {
+ s.FunctionName = &v
+ return s
}
-// SetOptionGroupName sets the OptionGroupName field's value.
-func (s *AwsRdsDbOptionGroupMembership) SetOptionGroupName(v string) *AwsRdsDbOptionGroupMembership {
- s.OptionGroupName = &v
+// SetHandler sets the Handler field's value.
+func (s *AwsLambdaFunctionDetails) SetHandler(v string) *AwsLambdaFunctionDetails {
+ s.Handler = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbOptionGroupMembership) SetStatus(v string) *AwsRdsDbOptionGroupMembership {
- s.Status = &v
+// SetKmsKeyArn sets the KmsKeyArn field's value.
+func (s *AwsLambdaFunctionDetails) SetKmsKeyArn(v string) *AwsLambdaFunctionDetails {
+ s.KmsKeyArn = &v
return s
}
-// Provides information about a parameter group for a DB instance.
-type AwsRdsDbParameterGroup struct {
- _ struct{} `type:"structure"`
-
- // The name of the parameter group.
- DbParameterGroupName *string `type:"string"`
+// SetLastModified sets the LastModified field's value.
+func (s *AwsLambdaFunctionDetails) SetLastModified(v string) *AwsLambdaFunctionDetails {
+ s.LastModified = &v
+ return s
+}
- // The status of parameter updates.
- ParameterApplyStatus *string `type:"string"`
+// SetLayers sets the Layers field's value.
+func (s *AwsLambdaFunctionDetails) SetLayers(v []*AwsLambdaFunctionLayer) *AwsLambdaFunctionDetails {
+ s.Layers = v
+ return s
}
-// String returns the string representation
-func (s AwsRdsDbParameterGroup) String() string {
- return awsutil.Prettify(s)
+// SetMasterArn sets the MasterArn field's value.
+func (s *AwsLambdaFunctionDetails) SetMasterArn(v string) *AwsLambdaFunctionDetails {
+ s.MasterArn = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsRdsDbParameterGroup) GoString() string {
- return s.String()
+// SetMemorySize sets the MemorySize field's value.
+func (s *AwsLambdaFunctionDetails) SetMemorySize(v int64) *AwsLambdaFunctionDetails {
+ s.MemorySize = &v
+ return s
}
-// SetDbParameterGroupName sets the DbParameterGroupName field's value.
-func (s *AwsRdsDbParameterGroup) SetDbParameterGroupName(v string) *AwsRdsDbParameterGroup {
- s.DbParameterGroupName = &v
+// SetRevisionId sets the RevisionId field's value.
+func (s *AwsLambdaFunctionDetails) SetRevisionId(v string) *AwsLambdaFunctionDetails {
+ s.RevisionId = &v
return s
}
-// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
-func (s *AwsRdsDbParameterGroup) SetParameterApplyStatus(v string) *AwsRdsDbParameterGroup {
- s.ParameterApplyStatus = &v
+// SetRole sets the Role field's value.
+func (s *AwsLambdaFunctionDetails) SetRole(v string) *AwsLambdaFunctionDetails {
+ s.Role = &v
return s
}
-// Changes to a DB instance that are currently pending.
-type AwsRdsDbPendingModifiedValues struct {
- _ struct{} `type:"structure"`
-
- // The new value of the allocated storage for the DB instance.
- AllocatedStorage *int64 `type:"integer"`
-
- // The new backup retention period for the DB instance.
- BackupRetentionPeriod *int64 `type:"integer"`
-
- // The new CA certificate identifier for the DB instance.
- CaCertificateIdentifier *string `type:"string"`
-
- // The new DB instance class for the DB instance.
- DbInstanceClass *string `type:"string"`
-
- // The new DB instance identifier for the DB instance.
- DbInstanceIdentifier *string `type:"string"`
-
- // The name of the new subnet group for the DB instance.
- DbSubnetGroupName *string `type:"string"`
-
- // The new engine version for the DB instance.
- EngineVersion *string `type:"string"`
-
- // The new provisioned IOPS value for the DB instance.
- Iops *int64 `type:"integer"`
+// SetRuntime sets the Runtime field's value.
+func (s *AwsLambdaFunctionDetails) SetRuntime(v string) *AwsLambdaFunctionDetails {
+ s.Runtime = &v
+ return s
+}
- // The new license model value for the DB instance.
- LicenseModel *string `type:"string"`
+// SetTimeout sets the Timeout field's value.
+func (s *AwsLambdaFunctionDetails) SetTimeout(v int64) *AwsLambdaFunctionDetails {
+ s.Timeout = &v
+ return s
+}
- // The new master user password for the DB instance.
- MasterUserPassword *string `type:"string"`
+// SetTracingConfig sets the TracingConfig field's value.
+func (s *AwsLambdaFunctionDetails) SetTracingConfig(v *AwsLambdaFunctionTracingConfig) *AwsLambdaFunctionDetails {
+ s.TracingConfig = v
+ return s
+}
- // Indicates that a single Availability Zone DB instance is changing to a multiple
- // Availability Zone deployment.
- MultiAZ *bool `type:"boolean"`
+// SetVersion sets the Version field's value.
+func (s *AwsLambdaFunctionDetails) SetVersion(v string) *AwsLambdaFunctionDetails {
+ s.Version = &v
+ return s
+}
- // A list of log types that are being enabled or disabled.
- PendingCloudWatchLogsExports *AwsRdsPendingCloudWatchLogsExports `type:"structure"`
+// SetVpcConfig sets the VpcConfig field's value.
+func (s *AwsLambdaFunctionDetails) SetVpcConfig(v *AwsLambdaFunctionVpcConfig) *AwsLambdaFunctionDetails {
+ s.VpcConfig = v
+ return s
+}
- // The new port for the DB instance.
- Port *int64 `type:"integer"`
+// A function's environment variable settings.
+type AwsLambdaFunctionEnvironment struct {
+ _ struct{} `type:"structure"`
- // Processor features that are being updated.
- ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
+ // An AwsLambdaFunctionEnvironmentError object.
+ Error *AwsLambdaFunctionEnvironmentError `type:"structure"`
- // The new storage type for the DB instance.
- StorageType *string `type:"string"`
+ // Environment variable key-value pairs.
+ Variables map[string]*string `type:"map"`
}
// String returns the string representation
-func (s AwsRdsDbPendingModifiedValues) String() string {
+func (s AwsLambdaFunctionEnvironment) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbPendingModifiedValues) GoString() string {
+func (s AwsLambdaFunctionEnvironment) GoString() string {
return s.String()
}
-// SetAllocatedStorage sets the AllocatedStorage field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetAllocatedStorage(v int64) *AwsRdsDbPendingModifiedValues {
- s.AllocatedStorage = &v
+// SetError sets the Error field's value.
+func (s *AwsLambdaFunctionEnvironment) SetError(v *AwsLambdaFunctionEnvironmentError) *AwsLambdaFunctionEnvironment {
+ s.Error = v
return s
}
-// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod(v int64) *AwsRdsDbPendingModifiedValues {
- s.BackupRetentionPeriod = &v
+// SetVariables sets the Variables field's value.
+func (s *AwsLambdaFunctionEnvironment) SetVariables(v map[string]*string) *AwsLambdaFunctionEnvironment {
+ s.Variables = v
return s
}
-// SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier(v string) *AwsRdsDbPendingModifiedValues {
- s.CaCertificateIdentifier = &v
- return s
+// Error messages for environment variables that could not be applied.
+type AwsLambdaFunctionEnvironmentError struct {
+ _ struct{} `type:"structure"`
+
+ // The error code.
+ ErrorCode *string `type:"string"`
+
+ // The error message.
+ Message *string `type:"string"`
}
-// SetDbInstanceClass sets the DbInstanceClass field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceClass(v string) *AwsRdsDbPendingModifiedValues {
- s.DbInstanceClass = &v
- return s
+// String returns the string representation
+func (s AwsLambdaFunctionEnvironmentError) String() string {
+ return awsutil.Prettify(s)
}
-// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceIdentifier(v string) *AwsRdsDbPendingModifiedValues {
- s.DbInstanceIdentifier = &v
- return s
+// GoString returns the string representation
+func (s AwsLambdaFunctionEnvironmentError) GoString() string {
+ return s.String()
}
-// SetDbSubnetGroupName sets the DbSubnetGroupName field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetDbSubnetGroupName(v string) *AwsRdsDbPendingModifiedValues {
- s.DbSubnetGroupName = &v
+// SetErrorCode sets the ErrorCode field's value.
+func (s *AwsLambdaFunctionEnvironmentError) SetErrorCode(v string) *AwsLambdaFunctionEnvironmentError {
+ s.ErrorCode = &v
return s
}
-// SetEngineVersion sets the EngineVersion field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetEngineVersion(v string) *AwsRdsDbPendingModifiedValues {
- s.EngineVersion = &v
+// SetMessage sets the Message field's value.
+func (s *AwsLambdaFunctionEnvironmentError) SetMessage(v string) *AwsLambdaFunctionEnvironmentError {
+ s.Message = &v
return s
}
-// SetIops sets the Iops field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetIops(v int64) *AwsRdsDbPendingModifiedValues {
- s.Iops = &v
- return s
+// An AWS Lambda layer.
+type AwsLambdaFunctionLayer struct {
+ _ struct{} `type:"structure"`
+
+ // The ARN of the function layer.
+ Arn *string `type:"string"`
+
+ // The size of the layer archive in bytes.
+ CodeSize *int64 `type:"integer"`
}
-// SetLicenseModel sets the LicenseModel field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetLicenseModel(v string) *AwsRdsDbPendingModifiedValues {
- s.LicenseModel = &v
- return s
+// String returns the string representation
+func (s AwsLambdaFunctionLayer) String() string {
+ return awsutil.Prettify(s)
}
-// SetMasterUserPassword sets the MasterUserPassword field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetMasterUserPassword(v string) *AwsRdsDbPendingModifiedValues {
- s.MasterUserPassword = &v
- return s
+// GoString returns the string representation
+func (s AwsLambdaFunctionLayer) GoString() string {
+ return s.String()
}
-// SetMultiAZ sets the MultiAZ field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetMultiAZ(v bool) *AwsRdsDbPendingModifiedValues {
- s.MultiAZ = &v
+// SetArn sets the Arn field's value.
+func (s *AwsLambdaFunctionLayer) SetArn(v string) *AwsLambdaFunctionLayer {
+ s.Arn = &v
return s
}
-// SetPendingCloudWatchLogsExports sets the PendingCloudWatchLogsExports field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetPendingCloudWatchLogsExports(v *AwsRdsPendingCloudWatchLogsExports) *AwsRdsDbPendingModifiedValues {
- s.PendingCloudWatchLogsExports = v
+// SetCodeSize sets the CodeSize field's value.
+func (s *AwsLambdaFunctionLayer) SetCodeSize(v int64) *AwsLambdaFunctionLayer {
+ s.CodeSize = &v
return s
}
-// SetPort sets the Port field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetPort(v int64) *AwsRdsDbPendingModifiedValues {
- s.Port = &v
- return s
+// The function's AWS X-Ray tracing configuration.
+type AwsLambdaFunctionTracingConfig struct {
+ _ struct{} `type:"structure"`
+
+ // The tracing mode.
+ Mode *string `type:"string"`
}
-// SetProcessorFeatures sets the ProcessorFeatures field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbPendingModifiedValues {
- s.ProcessorFeatures = v
- return s
+// String returns the string representation
+func (s AwsLambdaFunctionTracingConfig) String() string {
+ return awsutil.Prettify(s)
}
-// SetStorageType sets the StorageType field's value.
-func (s *AwsRdsDbPendingModifiedValues) SetStorageType(v string) *AwsRdsDbPendingModifiedValues {
- s.StorageType = &v
+// GoString returns the string representation
+func (s AwsLambdaFunctionTracingConfig) GoString() string {
+ return s.String()
+}
+
+// SetMode sets the Mode field's value.
+func (s *AwsLambdaFunctionTracingConfig) SetMode(v string) *AwsLambdaFunctionTracingConfig {
+ s.Mode = &v
return s
}
-// A processor feature.
-type AwsRdsDbProcessorFeature struct {
+// The VPC security groups and subnets that are attached to a Lambda function.
+type AwsLambdaFunctionVpcConfig struct {
_ struct{} `type:"structure"`
- // The name of the processor feature.
- Name *string `type:"string"`
+ // A list of VPC security groups IDs.
+ SecurityGroupIds []*string `type:"list"`
- // The value of the processor feature.
- Value *string `type:"string"`
+ // A list of VPC subnet IDs.
+ SubnetIds []*string `type:"list"`
+
+ // The ID of the VPC.
+ VpcId *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbProcessorFeature) String() string {
+func (s AwsLambdaFunctionVpcConfig) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbProcessorFeature) GoString() string {
+func (s AwsLambdaFunctionVpcConfig) GoString() string {
return s.String()
}
-// SetName sets the Name field's value.
-func (s *AwsRdsDbProcessorFeature) SetName(v string) *AwsRdsDbProcessorFeature {
- s.Name = &v
+// SetSecurityGroupIds sets the SecurityGroupIds field's value.
+func (s *AwsLambdaFunctionVpcConfig) SetSecurityGroupIds(v []*string) *AwsLambdaFunctionVpcConfig {
+ s.SecurityGroupIds = v
return s
}
-// SetValue sets the Value field's value.
-func (s *AwsRdsDbProcessorFeature) SetValue(v string) *AwsRdsDbProcessorFeature {
- s.Value = &v
+// SetSubnetIds sets the SubnetIds field's value.
+func (s *AwsLambdaFunctionVpcConfig) SetSubnetIds(v []*string) *AwsLambdaFunctionVpcConfig {
+ s.SubnetIds = v
return s
}
-// Provides details about an Amazon RDS DB cluster snapshot.
-type AwsRdsDbSnapshotDetails struct {
+// SetVpcId sets the VpcId field's value.
+func (s *AwsLambdaFunctionVpcConfig) SetVpcId(v string) *AwsLambdaFunctionVpcConfig {
+ s.VpcId = &v
+ return s
+}
+
+// Details about a Lambda layer version.
+type AwsLambdaLayerVersionDetails struct {
_ struct{} `type:"structure"`
- // The amount of storage (in gigabytes) to be initially allocated for the database
- // instance.
- AllocatedStorage *int64 `type:"integer"`
+ // The layer's compatible runtimes. Maximum number of five items.
+ //
+ // Valid values: nodejs10.x | nodejs12.x | java8 | java11 | python2.7 | python3.6
+ // | python3.7 | python3.8 | dotnetcore1.0 | dotnetcore2.1 | go1.x | ruby2.5
+ // | provided
+ CompatibleRuntimes []*string `type:"list"`
- // Specifies the name of the Availability Zone in which the DB instance was
- // located at the time of the DB snapshot.
- AvailabilityZone *string `type:"string"`
+ // Indicates when the version was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ CreatedDate *string `type:"string"`
- // A name for the DB instance.
- DbInstanceIdentifier *string `type:"string"`
+ // The version number.
+ Version *int64 `type:"long"`
+}
- // The name or ARN of the DB snapshot that is used to restore the DB instance.
- DbSnapshotIdentifier *string `type:"string"`
+// String returns the string representation
+func (s AwsLambdaLayerVersionDetails) String() string {
+ return awsutil.Prettify(s)
+}
- // The identifier for the source DB instance.
- DbiResourceId *string `type:"string"`
+// GoString returns the string representation
+func (s AwsLambdaLayerVersionDetails) GoString() string {
+ return s.String()
+}
- // Whether the DB snapshot is encrypted.
- Encrypted *bool `type:"boolean"`
+// SetCompatibleRuntimes sets the CompatibleRuntimes field's value.
+func (s *AwsLambdaLayerVersionDetails) SetCompatibleRuntimes(v []*string) *AwsLambdaLayerVersionDetails {
+ s.CompatibleRuntimes = v
+ return s
+}
- // The name of the database engine to use for this DB instance.
+// SetCreatedDate sets the CreatedDate field's value.
+func (s *AwsLambdaLayerVersionDetails) SetCreatedDate(v string) *AwsLambdaLayerVersionDetails {
+ s.CreatedDate = &v
+ return s
+}
+
+// SetVersion sets the Version field's value.
+func (s *AwsLambdaLayerVersionDetails) SetVersion(v int64) *AwsLambdaLayerVersionDetails {
+ s.Version = &v
+ return s
+}
+
+// An IAM role that is associated with the Amazon RDS DB cluster.
+type AwsRdsDbClusterAssociatedRole struct {
+ _ struct{} `type:"structure"`
+
+ // The ARN of the IAM role.
+ RoleArn *string `type:"string"`
+
+ // The status of the association between the IAM role and the DB cluster.
+ Status *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbClusterAssociatedRole) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbClusterAssociatedRole) GoString() string {
+ return s.String()
+}
+
+// SetRoleArn sets the RoleArn field's value.
+func (s *AwsRdsDbClusterAssociatedRole) SetRoleArn(v string) *AwsRdsDbClusterAssociatedRole {
+ s.RoleArn = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbClusterAssociatedRole) SetStatus(v string) *AwsRdsDbClusterAssociatedRole {
+ s.Status = &v
+ return s
+}
+
+// Information about an Amazon RDS DB cluster.
+type AwsRdsDbClusterDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The status of the database activity stream.
+ ActivityStreamStatus *string `type:"string"`
+
+ // For all database engines except Aurora, specifies the allocated storage size
+ // in gibibytes (GiB).
+ AllocatedStorage *int64 `type:"integer"`
+
+ // A list of the IAM roles that are associated with the DB cluster.
+ AssociatedRoles []*AwsRdsDbClusterAssociatedRole `type:"list"`
+
+ // A list of Availability Zones (AZs) where instances in the DB cluster can
+ // be created.
+ AvailabilityZones []*string `type:"list"`
+
+ // The number of days for which automated backups are retained.
+ BackupRetentionPeriod *int64 `type:"integer"`
+
+ // Indicates when the DB cluster was created, in Universal Coordinated Time
+ // (UTC).
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ ClusterCreateTime *string `type:"string"`
+
+ // Whether tags are copied from the DB cluster to snapshots of the DB cluster.
+ CopyTagsToSnapshot *bool `type:"boolean"`
+
+ // Whether the DB cluster is a clone of a DB cluster owned by a different AWS
+ // account.
+ CrossAccountClone *bool `type:"boolean"`
+
+ // A list of custom endpoints for the DB cluster.
+ CustomEndpoints []*string `type:"list"`
+
+ // The name of the database.
+ DatabaseName *string `type:"string"`
+
+ // The DB cluster identifier that the user assigned to the cluster. This identifier
+ // is the unique key that identifies a DB cluster.
+ DbClusterIdentifier *string `type:"string"`
+
+ // The list of instances that make up the DB cluster.
+ DbClusterMembers []*AwsRdsDbClusterMember `type:"list"`
+
+ // The list of option group memberships for this DB cluster.
+ DbClusterOptionGroupMemberships []*AwsRdsDbClusterOptionGroupMembership `type:"list"`
+
+ // The name of the DB cluster parameter group for the DB cluster.
+ DbClusterParameterGroup *string `type:"string"`
+
+ // The identifier of the DB cluster. The identifier must be unique within each
+ // AWS Region and is immutable.
+ DbClusterResourceId *string `type:"string"`
+
+ // The subnet group that is associated with the DB cluster, including the name,
+ // description, and subnets in the subnet group.
+ DbSubnetGroup *string `type:"string"`
+
+ // Whether the DB cluster has deletion protection enabled.
+ DeletionProtection *bool `type:"boolean"`
+
+ // The Active Directory domain membership records that are associated with the
+ // DB cluster.
+ DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`
+
+ // A list of log types that this DB cluster is configured to export to CloudWatch
+ // Logs.
+ EnabledCloudWatchLogsExports []*string `type:"list"`
+
+ // The connection endpoint for the primary instance of the DB cluster.
+ Endpoint *string `type:"string"`
+
+ // The name of the database engine to use for this DB cluster.
Engine *string `type:"string"`
- // The version of the database engine.
+ // The database engine mode of the DB cluster.
+ EngineMode *string `type:"string"`
+
+ // The version number of the database engine to use.
EngineVersion *string `type:"string"`
- // Whether mapping of IAM accounts to database accounts is enabled.
- IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
+ // Specifies the identifier that Amazon Route 53 assigns when you create a hosted
+ // zone.
+ HostedZoneId *string `type:"string"`
- // Specifies the time in Coordinated Universal Time (UTC) when the DB instance,
- // from which the snapshot was taken, was created.
- InstanceCreateTime *string `type:"string"`
+ // Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
+ HttpEndpointEnabled *bool `type:"boolean"`
- // The provisioned IOPS (I/O operations per second) value of the DB instance
- // at the time of the snapshot.
- Iops *int64 `type:"integer"`
+ // Whether the mapping of IAM accounts to database accounts is enabled.
+ IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
- // If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
+ // The ARN of the AWS KMS master key that is used to encrypt the database instances
+ // in the DB cluster.
KmsKeyId *string `type:"string"`
- // License model information for the restored DB instance.
- LicenseModel *string `type:"string"`
-
- // The master user name for the DB snapshot.
+ // The name of the master user for the DB cluster.
MasterUsername *string `type:"string"`
- // The option group name for the DB snapshot.
- OptionGroupName *string `type:"string"`
-
- // The percentage of the estimated data that has been transferred.
- PercentProgress *int64 `type:"integer"`
+ // Whether the DB cluster has instances in multiple Availability Zones.
+ MultiAz *bool `type:"boolean"`
- // The port that the database engine was listening on at the time of the snapshot.
+ // The port number on which the DB instances in the DB cluster accept connections.
Port *int64 `type:"integer"`
- // The number of CPU cores and the number of threads per core for the DB instance
- // class of the DB instance.
- ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
-
- // When the snapshot was taken in Coordinated Universal Time (UTC).
- SnapshotCreateTime *string `type:"string"`
+ // The range of time each day when automated backups are created, if automated
+ // backups are enabled.
+ //
+ // Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
+ PreferredBackupWindow *string `type:"string"`
- // The type of the DB snapshot.
- SnapshotType *string `type:"string"`
+ // The weekly time range during which system maintenance can occur, in Universal
+ // Coordinated Time (UTC).
+ //
+ // Uses the format :HH:MM-:HH:MM.
+ //
+ // For the day values, use mon|tue|wed|thu|fri|sat|sun.
+ //
+ // For example, sun:09:32-sun:10:02.
+ PreferredMaintenanceWindow *string `type:"string"`
- // The DB snapshot ARN that the DB snapshot was copied from.
- SourceDbSnapshotIdentifier *string `type:"string"`
+ // The identifiers of the read replicas that are associated with this DB cluster.
+ ReadReplicaIdentifiers []*string `type:"list"`
- // The AWS Region that the DB snapshot was created in or copied from.
- SourceRegion *string `type:"string"`
+ // The reader endpoint for the DB cluster.
+ ReaderEndpoint *string `type:"string"`
- // The status of this DB snapshot.
+ // The current status of this DB cluster.
Status *string `type:"string"`
- // The storage type associated with the DB snapshot.
- StorageType *string `type:"string"`
-
- // The ARN from the key store with which to associate the instance for TDE encryption.
- TdeCredentialArn *string `type:"string"`
-
- // The time zone of the DB snapshot.
- Timezone *string `type:"string"`
+ // Whether the DB cluster is encrypted.
+ StorageEncrypted *bool `type:"boolean"`
- // The VPC ID associated with the DB snapshot.
- VpcId *string `type:"string"`
+ // A list of VPC security groups that the DB cluster belongs to.
+ VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
}
// String returns the string representation
-func (s AwsRdsDbSnapshotDetails) String() string {
+func (s AwsRdsDbClusterDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbSnapshotDetails) GoString() string {
+func (s AwsRdsDbClusterDetails) GoString() string {
return s.String()
}
+// SetActivityStreamStatus sets the ActivityStreamStatus field's value.
+func (s *AwsRdsDbClusterDetails) SetActivityStreamStatus(v string) *AwsRdsDbClusterDetails {
+ s.ActivityStreamStatus = &v
+ return s
+}
+
// SetAllocatedStorage sets the AllocatedStorage field's value.
-func (s *AwsRdsDbSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbSnapshotDetails {
+func (s *AwsRdsDbClusterDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterDetails {
s.AllocatedStorage = &v
return s
}
-// SetAvailabilityZone sets the AvailabilityZone field's value.
-func (s *AwsRdsDbSnapshotDetails) SetAvailabilityZone(v string) *AwsRdsDbSnapshotDetails {
- s.AvailabilityZone = &v
+// SetAssociatedRoles sets the AssociatedRoles field's value.
+func (s *AwsRdsDbClusterDetails) SetAssociatedRoles(v []*AwsRdsDbClusterAssociatedRole) *AwsRdsDbClusterDetails {
+ s.AssociatedRoles = v
return s
}
-// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
-func (s *AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier(v string) *AwsRdsDbSnapshotDetails {
- s.DbInstanceIdentifier = &v
+// SetAvailabilityZones sets the AvailabilityZones field's value.
+func (s *AwsRdsDbClusterDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterDetails {
+ s.AvailabilityZones = v
return s
}
-// SetDbSnapshotIdentifier sets the DbSnapshotIdentifier field's value.
-func (s *AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails {
- s.DbSnapshotIdentifier = &v
+// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
+func (s *AwsRdsDbClusterDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbClusterDetails {
+ s.BackupRetentionPeriod = &v
return s
}
-// SetDbiResourceId sets the DbiResourceId field's value.
-func (s *AwsRdsDbSnapshotDetails) SetDbiResourceId(v string) *AwsRdsDbSnapshotDetails {
- s.DbiResourceId = &v
+// SetClusterCreateTime sets the ClusterCreateTime field's value.
+func (s *AwsRdsDbClusterDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterDetails {
+ s.ClusterCreateTime = &v
return s
}
-// SetEncrypted sets the Encrypted field's value.
-func (s *AwsRdsDbSnapshotDetails) SetEncrypted(v bool) *AwsRdsDbSnapshotDetails {
- s.Encrypted = &v
+// SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.
+func (s *AwsRdsDbClusterDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbClusterDetails {
+ s.CopyTagsToSnapshot = &v
return s
}
-// SetEngine sets the Engine field's value.
-func (s *AwsRdsDbSnapshotDetails) SetEngine(v string) *AwsRdsDbSnapshotDetails {
- s.Engine = &v
+// SetCrossAccountClone sets the CrossAccountClone field's value.
+func (s *AwsRdsDbClusterDetails) SetCrossAccountClone(v bool) *AwsRdsDbClusterDetails {
+ s.CrossAccountClone = &v
return s
}
-// SetEngineVersion sets the EngineVersion field's value.
-func (s *AwsRdsDbSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbSnapshotDetails {
- s.EngineVersion = &v
+// SetCustomEndpoints sets the CustomEndpoints field's value.
+func (s *AwsRdsDbClusterDetails) SetCustomEndpoints(v []*string) *AwsRdsDbClusterDetails {
+ s.CustomEndpoints = v
return s
}
-// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
-func (s *AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbSnapshotDetails {
- s.IamDatabaseAuthenticationEnabled = &v
+// SetDatabaseName sets the DatabaseName field's value.
+func (s *AwsRdsDbClusterDetails) SetDatabaseName(v string) *AwsRdsDbClusterDetails {
+ s.DatabaseName = &v
return s
}
-// SetInstanceCreateTime sets the InstanceCreateTime field's value.
-func (s *AwsRdsDbSnapshotDetails) SetInstanceCreateTime(v string) *AwsRdsDbSnapshotDetails {
- s.InstanceCreateTime = &v
+// SetDbClusterIdentifier sets the DbClusterIdentifier field's value.
+func (s *AwsRdsDbClusterDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterDetails {
+ s.DbClusterIdentifier = &v
return s
}
-// SetIops sets the Iops field's value.
-func (s *AwsRdsDbSnapshotDetails) SetIops(v int64) *AwsRdsDbSnapshotDetails {
- s.Iops = &v
+// SetDbClusterMembers sets the DbClusterMembers field's value.
+func (s *AwsRdsDbClusterDetails) SetDbClusterMembers(v []*AwsRdsDbClusterMember) *AwsRdsDbClusterDetails {
+ s.DbClusterMembers = v
return s
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsRdsDbSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbSnapshotDetails {
- s.KmsKeyId = &v
+// SetDbClusterOptionGroupMemberships sets the DbClusterOptionGroupMemberships field's value.
+func (s *AwsRdsDbClusterDetails) SetDbClusterOptionGroupMemberships(v []*AwsRdsDbClusterOptionGroupMembership) *AwsRdsDbClusterDetails {
+ s.DbClusterOptionGroupMemberships = v
return s
}
-// SetLicenseModel sets the LicenseModel field's value.
-func (s *AwsRdsDbSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbSnapshotDetails {
- s.LicenseModel = &v
+// SetDbClusterParameterGroup sets the DbClusterParameterGroup field's value.
+func (s *AwsRdsDbClusterDetails) SetDbClusterParameterGroup(v string) *AwsRdsDbClusterDetails {
+ s.DbClusterParameterGroup = &v
return s
}
-// SetMasterUsername sets the MasterUsername field's value.
-func (s *AwsRdsDbSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbSnapshotDetails {
- s.MasterUsername = &v
+// SetDbClusterResourceId sets the DbClusterResourceId field's value.
+func (s *AwsRdsDbClusterDetails) SetDbClusterResourceId(v string) *AwsRdsDbClusterDetails {
+ s.DbClusterResourceId = &v
return s
}
-// SetOptionGroupName sets the OptionGroupName field's value.
-func (s *AwsRdsDbSnapshotDetails) SetOptionGroupName(v string) *AwsRdsDbSnapshotDetails {
- s.OptionGroupName = &v
+// SetDbSubnetGroup sets the DbSubnetGroup field's value.
+func (s *AwsRdsDbClusterDetails) SetDbSubnetGroup(v string) *AwsRdsDbClusterDetails {
+ s.DbSubnetGroup = &v
return s
}
-// SetPercentProgress sets the PercentProgress field's value.
-func (s *AwsRdsDbSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbSnapshotDetails {
- s.PercentProgress = &v
+// SetDeletionProtection sets the DeletionProtection field's value.
+func (s *AwsRdsDbClusterDetails) SetDeletionProtection(v bool) *AwsRdsDbClusterDetails {
+ s.DeletionProtection = &v
return s
}
-// SetPort sets the Port field's value.
-func (s *AwsRdsDbSnapshotDetails) SetPort(v int64) *AwsRdsDbSnapshotDetails {
- s.Port = &v
+// SetDomainMemberships sets the DomainMemberships field's value.
+func (s *AwsRdsDbClusterDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbClusterDetails {
+ s.DomainMemberships = v
return s
}
-// SetProcessorFeatures sets the ProcessorFeatures field's value.
-func (s *AwsRdsDbSnapshotDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbSnapshotDetails {
- s.ProcessorFeatures = v
+// SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.
+func (s *AwsRdsDbClusterDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbClusterDetails {
+ s.EnabledCloudWatchLogsExports = v
return s
}
-// SetSnapshotCreateTime sets the SnapshotCreateTime field's value.
-func (s *AwsRdsDbSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbSnapshotDetails {
- s.SnapshotCreateTime = &v
+// SetEndpoint sets the Endpoint field's value.
+func (s *AwsRdsDbClusterDetails) SetEndpoint(v string) *AwsRdsDbClusterDetails {
+ s.Endpoint = &v
return s
}
-// SetSnapshotType sets the SnapshotType field's value.
-func (s *AwsRdsDbSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbSnapshotDetails {
- s.SnapshotType = &v
+// SetEngine sets the Engine field's value.
+func (s *AwsRdsDbClusterDetails) SetEngine(v string) *AwsRdsDbClusterDetails {
+ s.Engine = &v
return s
}
-// SetSourceDbSnapshotIdentifier sets the SourceDbSnapshotIdentifier field's value.
-func (s *AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails {
- s.SourceDbSnapshotIdentifier = &v
+// SetEngineMode sets the EngineMode field's value.
+func (s *AwsRdsDbClusterDetails) SetEngineMode(v string) *AwsRdsDbClusterDetails {
+ s.EngineMode = &v
return s
}
-// SetSourceRegion sets the SourceRegion field's value.
-func (s *AwsRdsDbSnapshotDetails) SetSourceRegion(v string) *AwsRdsDbSnapshotDetails {
- s.SourceRegion = &v
+// SetEngineVersion sets the EngineVersion field's value.
+func (s *AwsRdsDbClusterDetails) SetEngineVersion(v string) *AwsRdsDbClusterDetails {
+ s.EngineVersion = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRdsDbSnapshotDetails) SetStatus(v string) *AwsRdsDbSnapshotDetails {
- s.Status = &v
+// SetHostedZoneId sets the HostedZoneId field's value.
+func (s *AwsRdsDbClusterDetails) SetHostedZoneId(v string) *AwsRdsDbClusterDetails {
+ s.HostedZoneId = &v
return s
}
-// SetStorageType sets the StorageType field's value.
-func (s *AwsRdsDbSnapshotDetails) SetStorageType(v string) *AwsRdsDbSnapshotDetails {
- s.StorageType = &v
+// SetHttpEndpointEnabled sets the HttpEndpointEnabled field's value.
+func (s *AwsRdsDbClusterDetails) SetHttpEndpointEnabled(v bool) *AwsRdsDbClusterDetails {
+ s.HttpEndpointEnabled = &v
return s
}
-// SetTdeCredentialArn sets the TdeCredentialArn field's value.
-func (s *AwsRdsDbSnapshotDetails) SetTdeCredentialArn(v string) *AwsRdsDbSnapshotDetails {
- s.TdeCredentialArn = &v
+// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
+func (s *AwsRdsDbClusterDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterDetails {
+ s.IamDatabaseAuthenticationEnabled = &v
return s
}
-// SetTimezone sets the Timezone field's value.
-func (s *AwsRdsDbSnapshotDetails) SetTimezone(v string) *AwsRdsDbSnapshotDetails {
- s.Timezone = &v
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsRdsDbClusterDetails) SetKmsKeyId(v string) *AwsRdsDbClusterDetails {
+ s.KmsKeyId = &v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsRdsDbSnapshotDetails) SetVpcId(v string) *AwsRdsDbSnapshotDetails {
- s.VpcId = &v
+// SetMasterUsername sets the MasterUsername field's value.
+func (s *AwsRdsDbClusterDetails) SetMasterUsername(v string) *AwsRdsDbClusterDetails {
+ s.MasterUsername = &v
return s
}
-// Information about the status of a read replica.
-type AwsRdsDbStatusInfo struct {
- _ struct{} `type:"structure"`
-
- // If the read replica is currently in an error state, provides the error details.
- Message *string `type:"string"`
-
- // Whether the read replica instance is operating normally.
- Normal *bool `type:"boolean"`
-
- // The status of the read replica instance.
- Status *string `type:"string"`
+// SetMultiAz sets the MultiAz field's value.
+func (s *AwsRdsDbClusterDetails) SetMultiAz(v bool) *AwsRdsDbClusterDetails {
+ s.MultiAz = &v
+ return s
+}
- // The type of status. For a read replica, the status type is read replication.
- StatusType *string `type:"string"`
+// SetPort sets the Port field's value.
+func (s *AwsRdsDbClusterDetails) SetPort(v int64) *AwsRdsDbClusterDetails {
+ s.Port = &v
+ return s
}
-// String returns the string representation
-func (s AwsRdsDbStatusInfo) String() string {
- return awsutil.Prettify(s)
+// SetPreferredBackupWindow sets the PreferredBackupWindow field's value.
+func (s *AwsRdsDbClusterDetails) SetPreferredBackupWindow(v string) *AwsRdsDbClusterDetails {
+ s.PreferredBackupWindow = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsRdsDbStatusInfo) GoString() string {
- return s.String()
+// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
+func (s *AwsRdsDbClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbClusterDetails {
+ s.PreferredMaintenanceWindow = &v
+ return s
}
-// SetMessage sets the Message field's value.
-func (s *AwsRdsDbStatusInfo) SetMessage(v string) *AwsRdsDbStatusInfo {
- s.Message = &v
+// SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.
+func (s *AwsRdsDbClusterDetails) SetReadReplicaIdentifiers(v []*string) *AwsRdsDbClusterDetails {
+ s.ReadReplicaIdentifiers = v
return s
}
-// SetNormal sets the Normal field's value.
-func (s *AwsRdsDbStatusInfo) SetNormal(v bool) *AwsRdsDbStatusInfo {
- s.Normal = &v
+// SetReaderEndpoint sets the ReaderEndpoint field's value.
+func (s *AwsRdsDbClusterDetails) SetReaderEndpoint(v string) *AwsRdsDbClusterDetails {
+ s.ReaderEndpoint = &v
return s
}
// SetStatus sets the Status field's value.
-func (s *AwsRdsDbStatusInfo) SetStatus(v string) *AwsRdsDbStatusInfo {
+func (s *AwsRdsDbClusterDetails) SetStatus(v string) *AwsRdsDbClusterDetails {
s.Status = &v
return s
}
-// SetStatusType sets the StatusType field's value.
-func (s *AwsRdsDbStatusInfo) SetStatusType(v string) *AwsRdsDbStatusInfo {
- s.StatusType = &v
+// SetStorageEncrypted sets the StorageEncrypted field's value.
+func (s *AwsRdsDbClusterDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterDetails {
+ s.StorageEncrypted = &v
return s
}
-// Information about the subnet group for the database instance.
-type AwsRdsDbSubnetGroup struct {
- _ struct{} `type:"structure"`
-
- // The ARN of the subnet group.
- DbSubnetGroupArn *string `type:"string"`
+// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
+func (s *AwsRdsDbClusterDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbClusterDetails {
+ s.VpcSecurityGroups = v
+ return s
+}
- // The description of the subnet group.
- DbSubnetGroupDescription *string `type:"string"`
+// Information about an instance in the DB cluster.
+type AwsRdsDbClusterMember struct {
+ _ struct{} `type:"structure"`
- // The name of the subnet group.
- DbSubnetGroupName *string `type:"string"`
+ // The status of the DB cluster parameter group for this member of the DB cluster.
+ DbClusterParameterGroupStatus *string `type:"string"`
- // The status of the subnet group.
- SubnetGroupStatus *string `type:"string"`
+ // The instance identifier for this member of the DB cluster.
+ DbInstanceIdentifier *string `type:"string"`
- // A list of subnets in the subnet group.
- Subnets []*AwsRdsDbSubnetGroupSubnet `type:"list"`
+ // Whether the cluster member is the primary instance for the DB cluster.
+ IsClusterWriter *bool `type:"boolean"`
- // The VPC ID of the subnet group.
- VpcId *string `type:"string"`
+ // Specifies the order in which an Aurora replica is promoted to the primary
+ // instance when the existing primary instance fails.
+ PromotionTier *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsRdsDbSubnetGroup) String() string {
+func (s AwsRdsDbClusterMember) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbSubnetGroup) GoString() string {
+func (s AwsRdsDbClusterMember) GoString() string {
return s.String()
}
-// SetDbSubnetGroupArn sets the DbSubnetGroupArn field's value.
-func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupArn(v string) *AwsRdsDbSubnetGroup {
- s.DbSubnetGroupArn = &v
+// SetDbClusterParameterGroupStatus sets the DbClusterParameterGroupStatus field's value.
+func (s *AwsRdsDbClusterMember) SetDbClusterParameterGroupStatus(v string) *AwsRdsDbClusterMember {
+ s.DbClusterParameterGroupStatus = &v
return s
}
-// SetDbSubnetGroupDescription sets the DbSubnetGroupDescription field's value.
-func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription(v string) *AwsRdsDbSubnetGroup {
- s.DbSubnetGroupDescription = &v
+// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
+func (s *AwsRdsDbClusterMember) SetDbInstanceIdentifier(v string) *AwsRdsDbClusterMember {
+ s.DbInstanceIdentifier = &v
return s
}
-// SetDbSubnetGroupName sets the DbSubnetGroupName field's value.
-func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupName(v string) *AwsRdsDbSubnetGroup {
- s.DbSubnetGroupName = &v
+// SetIsClusterWriter sets the IsClusterWriter field's value.
+func (s *AwsRdsDbClusterMember) SetIsClusterWriter(v bool) *AwsRdsDbClusterMember {
+ s.IsClusterWriter = &v
return s
}
-// SetSubnetGroupStatus sets the SubnetGroupStatus field's value.
-func (s *AwsRdsDbSubnetGroup) SetSubnetGroupStatus(v string) *AwsRdsDbSubnetGroup {
- s.SubnetGroupStatus = &v
+// SetPromotionTier sets the PromotionTier field's value.
+func (s *AwsRdsDbClusterMember) SetPromotionTier(v int64) *AwsRdsDbClusterMember {
+ s.PromotionTier = &v
return s
}
-// SetSubnets sets the Subnets field's value.
-func (s *AwsRdsDbSubnetGroup) SetSubnets(v []*AwsRdsDbSubnetGroupSubnet) *AwsRdsDbSubnetGroup {
- s.Subnets = v
- return s
-}
-
-// SetVpcId sets the VpcId field's value.
-func (s *AwsRdsDbSubnetGroup) SetVpcId(v string) *AwsRdsDbSubnetGroup {
- s.VpcId = &v
- return s
-}
-
-// Information about a subnet in a subnet group.
-type AwsRdsDbSubnetGroupSubnet struct {
+// Information about an option group membership for a DB cluster.
+type AwsRdsDbClusterOptionGroupMembership struct {
_ struct{} `type:"structure"`
- // Information about the Availability Zone for a subnet in the subnet group.
- SubnetAvailabilityZone *AwsRdsDbSubnetGroupSubnetAvailabilityZone `type:"structure"`
-
- // The identifier of a subnet in the subnet group.
- SubnetIdentifier *string `type:"string"`
+ // The name of the DB cluster option group.
+ DbClusterOptionGroupName *string `type:"string"`
- // The status of a subnet in the subnet group.
- SubnetStatus *string `type:"string"`
+ // The status of the DB cluster option group.
+ Status *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsDbSubnetGroupSubnet) String() string {
+func (s AwsRdsDbClusterOptionGroupMembership) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsDbSubnetGroupSubnet) GoString() string {
+func (s AwsRdsDbClusterOptionGroupMembership) GoString() string {
return s.String()
}
-// SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.
-func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetAvailabilityZone(v *AwsRdsDbSubnetGroupSubnetAvailabilityZone) *AwsRdsDbSubnetGroupSubnet {
- s.SubnetAvailabilityZone = v
- return s
-}
-
-// SetSubnetIdentifier sets the SubnetIdentifier field's value.
-func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier(v string) *AwsRdsDbSubnetGroupSubnet {
- s.SubnetIdentifier = &v
+// SetDbClusterOptionGroupName sets the DbClusterOptionGroupName field's value.
+func (s *AwsRdsDbClusterOptionGroupMembership) SetDbClusterOptionGroupName(v string) *AwsRdsDbClusterOptionGroupMembership {
+ s.DbClusterOptionGroupName = &v
return s
}
-// SetSubnetStatus sets the SubnetStatus field's value.
-func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetStatus(v string) *AwsRdsDbSubnetGroupSubnet {
- s.SubnetStatus = &v
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbClusterOptionGroupMembership) SetStatus(v string) *AwsRdsDbClusterOptionGroupMembership {
+ s.Status = &v
return s
}
-// An Availability Zone for a subnet in a subnet group.
-type AwsRdsDbSubnetGroupSubnetAvailabilityZone struct {
+// Information about an Amazon RDS DB cluster snapshot.
+type AwsRdsDbClusterSnapshotDetails struct {
_ struct{} `type:"structure"`
- // The name of the Availability Zone for a subnet in the subnet group.
- Name *string `type:"string"`
-}
+ // Specifies the allocated storage size in gibibytes (GiB).
+ AllocatedStorage *int64 `type:"integer"`
-// String returns the string representation
-func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) String() string {
- return awsutil.Prettify(s)
-}
+ // A list of Availability Zones where instances in the DB cluster can be created.
+ AvailabilityZones []*string `type:"list"`
-// GoString returns the string representation
-func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) GoString() string {
- return s.String()
-}
+ // Indicates when the DB cluster was created, in Universal Coordinated Time
+ // (UTC).
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ ClusterCreateTime *string `type:"string"`
-// SetName sets the Name field's value.
-func (s *AwsRdsDbSubnetGroupSubnetAvailabilityZone) SetName(v string) *AwsRdsDbSubnetGroupSubnetAvailabilityZone {
- s.Name = &v
- return s
-}
+ // The DB cluster identifier.
+ DbClusterIdentifier *string `type:"string"`
-// Identifies the log types to enable and disable.
-type AwsRdsPendingCloudWatchLogsExports struct {
- _ struct{} `type:"structure"`
+ // The identifier of the DB cluster snapshot.
+ DbClusterSnapshotIdentifier *string `type:"string"`
- // A list of log types that are being disabled.
- LogTypesToDisable []*string `type:"list"`
+ // The name of the database engine that you want to use for this DB instance.
+ Engine *string `type:"string"`
- // A list of log types that are being enabled.
- LogTypesToEnable []*string `type:"list"`
+ // The version of the database engine to use.
+ EngineVersion *string `type:"string"`
+
+ // Whether mapping of IAM accounts to database accounts is enabled.
+ IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
+
+ // The ARN of the AWS KMS master key that is used to encrypt the database instances
+ // in the DB cluster.
+ KmsKeyId *string `type:"string"`
+
+ // The license model information for this DB cluster snapshot.
+ LicenseModel *string `type:"string"`
+
+ // The name of the master user for the DB cluster.
+ MasterUsername *string `type:"string"`
+
+ // Specifies the percentage of the estimated data that has been transferred.
+ PercentProgress *int64 `type:"integer"`
+
+ // The port number on which the DB instances in the DB cluster accept connections.
+ Port *int64 `type:"integer"`
+
+ // Indicates when the snapshot was taken.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ SnapshotCreateTime *string `type:"string"`
+
+ // The type of DB cluster snapshot.
+ SnapshotType *string `type:"string"`
+
+ // The status of this DB cluster snapshot.
+ Status *string `type:"string"`
+
+ // Whether the DB cluster is encrypted.
+ StorageEncrypted *bool `type:"boolean"`
+
+ // The VPC ID that is associated with the DB cluster snapshot.
+ VpcId *string `type:"string"`
}
// String returns the string representation
-func (s AwsRdsPendingCloudWatchLogsExports) String() string {
+func (s AwsRdsDbClusterSnapshotDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRdsPendingCloudWatchLogsExports) GoString() string {
+func (s AwsRdsDbClusterSnapshotDetails) GoString() string {
return s.String()
}
-// SetLogTypesToDisable sets the LogTypesToDisable field's value.
-func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToDisable(v []*string) *AwsRdsPendingCloudWatchLogsExports {
- s.LogTypesToDisable = v
+// SetAllocatedStorage sets the AllocatedStorage field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbClusterSnapshotDetails {
+ s.AllocatedStorage = &v
return s
}
-// SetLogTypesToEnable sets the LogTypesToEnable field's value.
-func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToEnable(v []*string) *AwsRdsPendingCloudWatchLogsExports {
- s.LogTypesToEnable = v
+// SetAvailabilityZones sets the AvailabilityZones field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetAvailabilityZones(v []*string) *AwsRdsDbClusterSnapshotDetails {
+ s.AvailabilityZones = v
return s
}
-// A node in an Amazon Redshift cluster.
-type AwsRedshiftClusterClusterNode struct {
- _ struct{} `type:"structure"`
-
- // The role of the node. A node might be a leader node or a compute node.
- NodeRole *string `type:"string"`
-
- // The private IP address of the node.
- PrivateIpAddress *string `type:"string"`
-
- // The public IP address of the node.
- PublicIpAddress *string `type:"string"`
+// SetClusterCreateTime sets the ClusterCreateTime field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetClusterCreateTime(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.ClusterCreateTime = &v
+ return s
}
-// String returns the string representation
-func (s AwsRedshiftClusterClusterNode) String() string {
- return awsutil.Prettify(s)
+// SetDbClusterIdentifier sets the DbClusterIdentifier field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterIdentifier(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.DbClusterIdentifier = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsRedshiftClusterClusterNode) GoString() string {
- return s.String()
+// SetDbClusterSnapshotIdentifier sets the DbClusterSnapshotIdentifier field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetDbClusterSnapshotIdentifier(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.DbClusterSnapshotIdentifier = &v
+ return s
}
-// SetNodeRole sets the NodeRole field's value.
-func (s *AwsRedshiftClusterClusterNode) SetNodeRole(v string) *AwsRedshiftClusterClusterNode {
- s.NodeRole = &v
+// SetEngine sets the Engine field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetEngine(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.Engine = &v
return s
}
-// SetPrivateIpAddress sets the PrivateIpAddress field's value.
-func (s *AwsRedshiftClusterClusterNode) SetPrivateIpAddress(v string) *AwsRedshiftClusterClusterNode {
- s.PrivateIpAddress = &v
+// SetEngineVersion sets the EngineVersion field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.EngineVersion = &v
return s
}
-// SetPublicIpAddress sets the PublicIpAddress field's value.
-func (s *AwsRedshiftClusterClusterNode) SetPublicIpAddress(v string) *AwsRedshiftClusterClusterNode {
- s.PublicIpAddress = &v
+// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbClusterSnapshotDetails {
+ s.IamDatabaseAuthenticationEnabled = &v
return s
}
-// A cluster parameter group that is associated with an Amazon Redshift cluster.
-type AwsRedshiftClusterClusterParameterGroup struct {
- _ struct{} `type:"structure"`
-
- // The list of parameter statuses.
- ClusterParameterStatusList []*AwsRedshiftClusterClusterParameterStatus `type:"list"`
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.KmsKeyId = &v
+ return s
+}
- // The status of updates to the parameters.
- ParameterApplyStatus *string `type:"string"`
+// SetLicenseModel sets the LicenseModel field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.LicenseModel = &v
+ return s
+}
- // The name of the parameter group.
- ParameterGroupName *string `type:"string"`
+// SetMasterUsername sets the MasterUsername field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.MasterUsername = &v
+ return s
}
-// String returns the string representation
-func (s AwsRedshiftClusterClusterParameterGroup) String() string {
- return awsutil.Prettify(s)
+// SetPercentProgress sets the PercentProgress field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbClusterSnapshotDetails {
+ s.PercentProgress = &v
+ return s
}
-// GoString returns the string representation
-func (s AwsRedshiftClusterClusterParameterGroup) GoString() string {
- return s.String()
+// SetPort sets the Port field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetPort(v int64) *AwsRdsDbClusterSnapshotDetails {
+ s.Port = &v
+ return s
}
-// SetClusterParameterStatusList sets the ClusterParameterStatusList field's value.
-func (s *AwsRedshiftClusterClusterParameterGroup) SetClusterParameterStatusList(v []*AwsRedshiftClusterClusterParameterStatus) *AwsRedshiftClusterClusterParameterGroup {
- s.ClusterParameterStatusList = v
+// SetSnapshotCreateTime sets the SnapshotCreateTime field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.SnapshotCreateTime = &v
return s
}
-// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
-func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterGroup {
- s.ParameterApplyStatus = &v
+// SetSnapshotType sets the SnapshotType field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.SnapshotType = &v
return s
}
-// SetParameterGroupName sets the ParameterGroupName field's value.
-func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterGroupName(v string) *AwsRedshiftClusterClusterParameterGroup {
- s.ParameterGroupName = &v
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetStatus(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.Status = &v
return s
}
-// The status of a parameter in a cluster parameter group for an Amazon Redshift
-// cluster.
-type AwsRedshiftClusterClusterParameterStatus struct {
- _ struct{} `type:"structure"`
-
- // The error that prevented the parameter from being applied to the database.
- ParameterApplyErrorDescription *string `type:"string"`
-
- // The status of the parameter. Indicates whether the parameter is in sync with
- // the database, waiting for a cluster reboot, or encountered an error when
- // it was applied.
- //
- // Valid values: in-sync | pending-reboot | applying | invalid-parameter | apply-deferred
- // | apply-error | unknown-error
- ParameterApplyStatus *string `type:"string"`
-
- // The name of the parameter.
- ParameterName *string `type:"string"`
-}
-
-// String returns the string representation
-func (s AwsRedshiftClusterClusterParameterStatus) String() string {
- return awsutil.Prettify(s)
-}
-
-// GoString returns the string representation
-func (s AwsRedshiftClusterClusterParameterStatus) GoString() string {
- return s.String()
-}
-
-// SetParameterApplyErrorDescription sets the ParameterApplyErrorDescription field's value.
-func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyErrorDescription(v string) *AwsRedshiftClusterClusterParameterStatus {
- s.ParameterApplyErrorDescription = &v
- return s
-}
-
-// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
-func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterStatus {
- s.ParameterApplyStatus = &v
+// SetStorageEncrypted sets the StorageEncrypted field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetStorageEncrypted(v bool) *AwsRdsDbClusterSnapshotDetails {
+ s.StorageEncrypted = &v
return s
}
-// SetParameterName sets the ParameterName field's value.
-func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterName(v string) *AwsRedshiftClusterClusterParameterStatus {
- s.ParameterName = &v
+// SetVpcId sets the VpcId field's value.
+func (s *AwsRdsDbClusterSnapshotDetails) SetVpcId(v string) *AwsRdsDbClusterSnapshotDetails {
+ s.VpcId = &v
return s
}
-// A security group that is associated with the cluster.
-type AwsRedshiftClusterClusterSecurityGroup struct {
+// Information about an Active Directory domain membership record associated
+// with the DB instance.
+type AwsRdsDbDomainMembership struct {
_ struct{} `type:"structure"`
- // The name of the cluster security group.
- ClusterSecurityGroupName *string `type:"string"`
+ // The identifier of the Active Directory domain.
+ Domain *string `type:"string"`
- // The status of the cluster security group.
+ // The fully qualified domain name of the Active Directory domain.
+ Fqdn *string `type:"string"`
+
+ // The name of the IAM role to use when making API calls to the Directory Service.
+ IamRoleName *string `type:"string"`
+
+ // The status of the Active Directory Domain membership for the DB instance.
Status *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterClusterSecurityGroup) String() string {
+func (s AwsRdsDbDomainMembership) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterClusterSecurityGroup) GoString() string {
+func (s AwsRdsDbDomainMembership) GoString() string {
return s.String()
}
-// SetClusterSecurityGroupName sets the ClusterSecurityGroupName field's value.
-func (s *AwsRedshiftClusterClusterSecurityGroup) SetClusterSecurityGroupName(v string) *AwsRedshiftClusterClusterSecurityGroup {
- s.ClusterSecurityGroupName = &v
+// SetDomain sets the Domain field's value.
+func (s *AwsRdsDbDomainMembership) SetDomain(v string) *AwsRdsDbDomainMembership {
+ s.Domain = &v
+ return s
+}
+
+// SetFqdn sets the Fqdn field's value.
+func (s *AwsRdsDbDomainMembership) SetFqdn(v string) *AwsRdsDbDomainMembership {
+ s.Fqdn = &v
+ return s
+}
+
+// SetIamRoleName sets the IamRoleName field's value.
+func (s *AwsRdsDbDomainMembership) SetIamRoleName(v string) *AwsRdsDbDomainMembership {
+ s.IamRoleName = &v
return s
}
// SetStatus sets the Status field's value.
-func (s *AwsRedshiftClusterClusterSecurityGroup) SetStatus(v string) *AwsRedshiftClusterClusterSecurityGroup {
+func (s *AwsRdsDbDomainMembership) SetStatus(v string) *AwsRdsDbDomainMembership {
s.Status = &v
return s
}
-// Information about a cross-Region snapshot copy.
-type AwsRedshiftClusterClusterSnapshotCopyStatus struct {
+// An AWS Identity and Access Management (IAM) role associated with the DB instance.
+type AwsRdsDbInstanceAssociatedRole struct {
_ struct{} `type:"structure"`
- // The destination Region that snapshots are automatically copied to when cross-Region
- // snapshot copy is enabled.
- DestinationRegion *string `type:"string"`
+ // The name of the feature associated with the IAM)role.
+ FeatureName *string `type:"string"`
- // The number of days that manual snapshots are retained in the destination
- // region after they are copied from a source region.
+ // The ARN of the IAM role that is associated with the DB instance.
+ RoleArn *string `type:"string"`
+
+ // Describes the state of the association between the IAM role and the DB instance.
+ // The Status property returns one of the following values:
//
- // If the value is -1, then the manual snapshot is retained indefinitely.
+ // * ACTIVE - The IAM role ARN is associated with the DB instance and can
+ // be used to access other AWS services on your behalf.
//
- // Valid values: Either -1 or an integer between 1 and 3,653
- ManualSnapshotRetentionPeriod *int64 `type:"integer"`
-
- // The number of days to retain automated snapshots in the destination Region
- // after they are copied from a source Region.
- RetentionPeriod *int64 `type:"integer"`
-
- // The name of the snapshot copy grant.
- SnapshotCopyGrantName *string `type:"string"`
+ // * PENDING - The IAM role ARN is being associated with the DB instance.
+ //
+ // * INVALID - The IAM role ARN is associated with the DB instance. But the
+ // DB instance is unable to assume the IAM role in order to access other
+ // AWS services on your behalf.
+ Status *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterClusterSnapshotCopyStatus) String() string {
+func (s AwsRdsDbInstanceAssociatedRole) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterClusterSnapshotCopyStatus) GoString() string {
+func (s AwsRdsDbInstanceAssociatedRole) GoString() string {
return s.String()
}
-// SetDestinationRegion sets the DestinationRegion field's value.
-func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetDestinationRegion(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus {
- s.DestinationRegion = &v
- return s
-}
-
-// SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.
-func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus {
- s.ManualSnapshotRetentionPeriod = &v
+// SetFeatureName sets the FeatureName field's value.
+func (s *AwsRdsDbInstanceAssociatedRole) SetFeatureName(v string) *AwsRdsDbInstanceAssociatedRole {
+ s.FeatureName = &v
return s
}
-// SetRetentionPeriod sets the RetentionPeriod field's value.
-func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus {
- s.RetentionPeriod = &v
+// SetRoleArn sets the RoleArn field's value.
+func (s *AwsRdsDbInstanceAssociatedRole) SetRoleArn(v string) *AwsRdsDbInstanceAssociatedRole {
+ s.RoleArn = &v
return s
}
-// SetSnapshotCopyGrantName sets the SnapshotCopyGrantName field's value.
-func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetSnapshotCopyGrantName(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus {
- s.SnapshotCopyGrantName = &v
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbInstanceAssociatedRole) SetStatus(v string) *AwsRdsDbInstanceAssociatedRole {
+ s.Status = &v
return s
}
-// A time windows during which maintenance was deferred for an Amazon Redshift
-// cluster.
-type AwsRedshiftClusterDeferredMaintenanceWindow struct {
+// Contains the details of an Amazon RDS DB instance.
+type AwsRdsDbInstanceDetails struct {
_ struct{} `type:"structure"`
- // The end of the time window for which maintenance was deferred.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- DeferMaintenanceEndTime *string `type:"string"`
-
- // The identifier of the maintenance window.
- DeferMaintenanceIdentifier *string `type:"string"`
+ // The amount of storage (in gigabytes) to initially allocate for the DB instance.
+ AllocatedStorage *int64 `type:"integer"`
- // The start of the time window for which maintenance was deferred.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- DeferMaintenanceStartTime *string `type:"string"`
-}
+ // The AWS Identity and Access Management (IAM) roles associated with the DB
+ // instance.
+ AssociatedRoles []*AwsRdsDbInstanceAssociatedRole `type:"list"`
-// String returns the string representation
-func (s AwsRedshiftClusterDeferredMaintenanceWindow) String() string {
- return awsutil.Prettify(s)
-}
+ // Indicates whether minor version patches are applied automatically.
+ AutoMinorVersionUpgrade *bool `type:"boolean"`
-// GoString returns the string representation
-func (s AwsRedshiftClusterDeferredMaintenanceWindow) GoString() string {
- return s.String()
-}
+ // The Availability Zone where the DB instance will be created.
+ AvailabilityZone *string `type:"string"`
-// SetDeferMaintenanceEndTime sets the DeferMaintenanceEndTime field's value.
-func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceEndTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
- s.DeferMaintenanceEndTime = &v
- return s
-}
+ // The number of days for which to retain automated backups.
+ BackupRetentionPeriod *int64 `type:"integer"`
-// SetDeferMaintenanceIdentifier sets the DeferMaintenanceIdentifier field's value.
-func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceIdentifier(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
- s.DeferMaintenanceIdentifier = &v
- return s
-}
+ // The identifier of the CA certificate for this DB instance.
+ CACertificateIdentifier *string `type:"string"`
-// SetDeferMaintenanceStartTime sets the DeferMaintenanceStartTime field's value.
-func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceStartTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
- s.DeferMaintenanceStartTime = &v
- return s
-}
+ // The name of the character set that this DB instance is associated with.
+ CharacterSetName *string `type:"string"`
-// Details about an Amazon Redshift cluster.
-type AwsRedshiftClusterDetails struct {
- _ struct{} `type:"structure"`
+ // Whether to copy resource tags to snapshots of the DB instance.
+ CopyTagsToSnapshot *bool `type:"boolean"`
- // Indicates whether major version upgrades are applied automatically to the
- // cluster during the maintenance window.
- AllowVersionUpgrade *bool `type:"boolean"`
+ // If the DB instance is a member of a DB cluster, contains the name of the
+ // DB cluster that the DB instance is a member of.
+ DBClusterIdentifier *string `type:"string"`
- // The number of days that automatic cluster snapshots are retained.
- AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`
+ // Contains the name of the compute and memory capacity class of the DB instance.
+ DBInstanceClass *string `type:"string"`
- // The name of the Availability Zone in which the cluster is located.
- AvailabilityZone *string `type:"string"`
+ // Contains a user-supplied database identifier. This identifier is the unique
+ // key that identifies a DB instance.
+ DBInstanceIdentifier *string `type:"string"`
- // The availability status of the cluster for queries. Possible values are the
- // following:
- //
- // * Available - The cluster is available for queries.
+ // The meaning of this parameter differs according to the database engine you
+ // use.
//
- // * Unavailable - The cluster is not available for queries.
+ // MySQL, MariaDB, SQL Server, PostgreSQL
//
- // * Maintenance - The cluster is intermittently available for queries due
- // to maintenance activities.
+ // Contains the name of the initial database of this instance that was provided
+ // at create time, if one was specified when the DB instance was created. This
+ // same name is returned for the life of the DB instance.
//
- // * Modifying -The cluster is intermittently available for queries due to
- // changes that modify the cluster.
+ // Oracle
//
- // * Failed - The cluster failed and is not available for queries.
- ClusterAvailabilityStatus *string `type:"string"`
+ // Contains the Oracle System ID (SID) of the created DB instance. Not shown
+ // when the returned parameters do not apply to an Oracle DB instance.
+ DBName *string `type:"string"`
- // Indicates when the cluster was created.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- ClusterCreateTime *string `type:"string"`
+ // Specifies the port that the DB instance listens on. If the DB instance is
+ // part of a DB cluster, this can be a different port than the DB cluster port.
+ DbInstancePort *int64 `type:"integer"`
- // The unique identifier of the cluster.
- ClusterIdentifier *string `type:"string"`
-
- // The nodes in the cluster.
- ClusterNodes []*AwsRedshiftClusterClusterNode `type:"list"`
-
- // The list of cluster parameter groups that are associated with this cluster.
- ClusterParameterGroups []*AwsRedshiftClusterClusterParameterGroup `type:"list"`
+ // The current status of the DB instance.
+ DbInstanceStatus *string `type:"string"`
- // The public key for the cluster.
- ClusterPublicKey *string `type:"string"`
+ // A list of the DB parameter groups to assign to the DB instance.
+ DbParameterGroups []*AwsRdsDbParameterGroup `type:"list"`
- // The specific revision number of the database in the cluster.
- ClusterRevisionNumber *string `type:"string"`
+ // A list of the DB security groups to assign to the DB instance.
+ DbSecurityGroups []*string `type:"list"`
- // A list of cluster security groups that are associated with the cluster.
- ClusterSecurityGroups []*AwsRedshiftClusterClusterSecurityGroup `type:"list"`
+ // Information about the subnet group that is associated with the DB instance.
+ DbSubnetGroup *AwsRdsDbSubnetGroup `type:"structure"`
- // Information about the destination Region and retention period for the cross-Region
- // snapshot copy.
- ClusterSnapshotCopyStatus *AwsRedshiftClusterClusterSnapshotCopyStatus `type:"structure"`
+ // The AWS Region-unique, immutable identifier for the DB instance. This identifier
+ // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB
+ // instance is accessed.
+ DbiResourceId *string `type:"string"`
- // The current status of the cluster.
+ // Indicates whether the DB instance has deletion protection enabled.
//
- // Valid values: available | available, prep-for-resize | available, resize-cleanup
- // |cancelling-resize | creating | deleting | final-snapshot | hardware-failure
- // | incompatible-hsm |incompatible-network | incompatible-parameters | incompatible-restore
- // | modifying | paused | rebooting | renaming | resizing | rotating-keys |
- // storage-full | updating-hsm
- ClusterStatus *string `type:"string"`
+ // When deletion protection is enabled, the database cannot be deleted.
+ DeletionProtection *bool `type:"boolean"`
- // The name of the subnet group that is associated with the cluster. This parameter
- // is valid only when the cluster is in a VPC.
- ClusterSubnetGroupName *string `type:"string"`
+ // The Active Directory domain membership records associated with the DB instance.
+ DomainMemberships []*AwsRdsDbDomainMembership `type:"list"`
- // The version ID of the Amazon Redshift engine that runs on the cluster.
- ClusterVersion *string `type:"string"`
+ // A list of log types that this DB instance is configured to export to CloudWatch
+ // Logs.
+ EnabledCloudWatchLogsExports []*string `type:"list"`
- // The name of the initial database that was created when the cluster was created.
- //
- // The same name is returned for the life of the cluster.
- //
- // If an initial database is not specified, a database named devdev is created
- // by default.
- DBName *string `type:"string"`
+ // Specifies the connection endpoint.
+ Endpoint *AwsRdsDbInstanceEndpoint `type:"structure"`
- // List of time windows during which maintenance was deferred.
- DeferredMaintenanceWindows []*AwsRedshiftClusterDeferredMaintenanceWindow `type:"list"`
+ // Provides the name of the database engine to use for this DB instance.
+ Engine *string `type:"string"`
- // Information about the status of the Elastic IP (EIP) address.
- ElasticIpStatus *AwsRedshiftClusterElasticIpStatus `type:"structure"`
+ // Indicates the database engine version.
+ EngineVersion *string `type:"string"`
- // The number of nodes that you can use the elastic resize method to resize
- // the cluster to.
- ElasticResizeNumberOfNodeOptions *string `type:"string"`
+ // The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring
+ // metrics data for the DB instance.
+ EnhancedMonitoringResourceArn *string `type:"string"`
- // Indicates whether the data in the cluster is encrypted at rest.
- Encrypted *bool `type:"boolean"`
+ // True if mapping of AWS Identity and Access Management (IAM) accounts to database
+ // accounts is enabled, and otherwise false.
+ //
+ // IAM database authentication can be enabled for the following database engines.
+ //
+ // * For MySQL 5.6, minor version 5.6.34 or higher
+ //
+ // * For MySQL 5.7, minor version 5.7.16 or higher
+ //
+ // * Aurora 5.6 or higher
+ IAMDatabaseAuthenticationEnabled *bool `type:"boolean"`
- // The connection endpoint.
- Endpoint *AwsRedshiftClusterEndpoint `type:"structure"`
+ // Indicates when the DB instance was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ InstanceCreateTime *string `type:"string"`
- // Indicates whether to create the cluster with enhanced VPC routing enabled.
- EnhancedVpcRouting *bool `type:"boolean"`
+ // Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
+ Iops *int64 `type:"integer"`
- // Indicates when the next snapshot is expected to be taken. The cluster must
- // have a valid snapshot schedule and have backups enabled.
+ // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted
+ // DB instance.
+ KmsKeyId *string `type:"string"`
+
+ // Specifies the latest time to which a database can be restored with point-in-time
+ // restore.
//
// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
// Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
// contain spaces. For example, 2020-03-22T13:22:13.933Z.
- ExpectedNextSnapshotScheduleTime *string `type:"string"`
+ LatestRestorableTime *string `type:"string"`
- // The status of the next expected snapshot.
- //
- // Valid values: OnTrack | Pending
- ExpectedNextSnapshotScheduleTimeStatus *string `type:"string"`
+ // License model information for this DB instance.
+ LicenseModel *string `type:"string"`
- // Information about whether the Amazon Redshift cluster finished applying any
- // changes to hardware security module (HSM) settings that were specified in
- // a modify cluster command.
- HsmStatus *AwsRedshiftClusterHsmStatus `type:"structure"`
+ // Specifies the connection endpoint.
+ ListenerEndpoint *AwsRdsDbInstanceEndpoint `type:"structure"`
- // A list of IAM roles that the cluster can use to access other AWS services.
- IamRoles []*AwsRedshiftClusterIamRole `type:"list"`
+ // The master user name of the DB instance.
+ MasterUsername *string `type:"string"`
- // The identifier of the AWS KMS encryption key that is used to encrypt data
- // in the cluster.
- KmsKeyId *string `type:"string"`
+ // The upper limit to which Amazon RDS can automatically scale the storage of
+ // the DB instance.
+ MaxAllocatedStorage *int64 `type:"integer"`
- // The name of the maintenance track for the cluster.
- MaintenanceTrackName *string `type:"string"`
+ // The interval, in seconds, between points when enhanced monitoring metrics
+ // are collected for the DB instance.
+ MonitoringInterval *int64 `type:"integer"`
- // The default number of days to retain a manual snapshot.
- //
- // If the value is -1, the snapshot is retained indefinitely.
- //
- // This setting doesn't change the retention period of existing snapshots.
- //
- // Valid values: Either -1 or an integer between 1 and 3,653
- ManualSnapshotRetentionPeriod *int64 `type:"integer"`
+ // The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring
+ // metrics to CloudWatch Logs.
+ MonitoringRoleArn *string `type:"string"`
- // The master user name for the cluster. This name is used to connect to the
- // database that is specified in as the value of DBName.
- MasterUsername *string `type:"string"`
+ // Whether the DB instance is a multiple Availability Zone deployment.
+ MultiAz *bool `type:"boolean"`
- // Indicates the start of the next maintenance window.
- //
- // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
- // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
- // contain spaces. For example, 2020-03-22T13:22:13.933Z.
- NextMaintenanceWindowStartTime *string `type:"string"`
+ // The list of option group memberships for this DB instance.
+ OptionGroupMemberships []*AwsRdsDbOptionGroupMembership `type:"list"`
- // The node type for the nodes in the cluster.
- NodeType *string `type:"string"`
+ // Changes to the DB instance that are currently pending.
+ PendingModifiedValues *AwsRdsDbPendingModifiedValues `type:"structure"`
- // The number of compute nodes in the cluster.
- NumberOfNodes *int64 `type:"integer"`
+ // Indicates whether Performance Insights is enabled for the DB instance.
+ PerformanceInsightsEnabled *bool `type:"boolean"`
- // A list of cluster operations that are waiting to start.
- PendingActions []*string `type:"list"`
+ // The identifier of the AWS KMS key used to encrypt the Performance Insights
+ // data.
+ PerformanceInsightsKmsKeyId *string `type:"string"`
- // A list of changes to the cluster that are currently pending.
- PendingModifiedValues *AwsRedshiftClusterPendingModifiedValues `type:"structure"`
+ // The number of days to retain Performance Insights data.
+ PerformanceInsightsRetentionPeriod *int64 `type:"integer"`
- // The weekly time range, in Universal Coordinated Time (UTC), during which
- // system maintenance can occur.
+ // The range of time each day when automated backups are created, if automated
+ // backups are enabled.
//
- // Format: :HH:MM-:HH:MM
+ // Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
+ PreferredBackupWindow *string `type:"string"`
+
+ // The weekly time range during which system maintenance can occur, in Universal
+ // Coordinated Time (UTC).
//
- // For the day values, use mon | tue | wed | thu | fri | sat | sun
+ // Uses the format :HH:MM-:HH:MM.
//
- // For example, sun:09:32-sun:10:02
+ // For the day values, use mon|tue|wed|thu|fri|sat|sun.
+ //
+ // For example, sun:09:32-sun:10:02.
PreferredMaintenanceWindow *string `type:"string"`
- // Whether the cluster can be accessed from a public network.
+ // The number of CPU cores and the number of threads per core for the DB instance
+ // class of the DB instance.
+ ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
+
+ // The order in which to promote an Aurora replica to the primary instance after
+ // a failure of the existing primary instance.
+ PromotionTier *int64 `type:"integer"`
+
+ // Specifies the accessibility options for the DB instance.
+ //
+ // A value of true specifies an Internet-facing instance with a publicly resolvable
+ // DNS name, which resolves to a public IP address.
+ //
+ // A value of false specifies an internal instance with a DNS name that resolves
+ // to a private IP address.
PubliclyAccessible *bool `type:"boolean"`
- // Information about the resize operation for the cluster.
- ResizeInfo *AwsRedshiftClusterResizeInfo `type:"structure"`
+ // List of identifiers of Aurora DB clusters to which the RDS DB instance is
+ // replicated as a read replica.
+ ReadReplicaDBClusterIdentifiers []*string `type:"list"`
- // Information about the status of a cluster restore action. Only applies to
- // a cluster that was created by restoring a snapshot.
- RestoreStatus *AwsRedshiftClusterRestoreStatus `type:"structure"`
+ // List of identifiers of the read replicas associated with this DB instance.
+ ReadReplicaDBInstanceIdentifiers []*string `type:"list"`
- // A unique identifier for the cluster snapshot schedule.
- SnapshotScheduleIdentifier *string `type:"string"`
+ // If this DB instance is a read replica, contains the identifier of the source
+ // DB instance.
+ ReadReplicaSourceDBInstanceIdentifier *string `type:"string"`
- // The current state of the cluster snapshot schedule.
- //
- // Valid values: MODIFYING | ACTIVE | FAILED
- SnapshotScheduleState *string `type:"string"`
+ // For a DB instance with multi-Availability Zone support, the name of the secondary
+ // Availability Zone.
+ SecondaryAvailabilityZone *string `type:"string"`
- // The identifier of the VPC that the cluster is in, if the cluster is in a
- // VPC.
- VpcId *string `type:"string"`
+ // The status of a read replica. If the instance isn't a read replica, this
+ // is empty.
+ StatusInfos []*AwsRdsDbStatusInfo `type:"list"`
- // The list of VPC security groups that the cluster belongs to, if the cluster
- // is in a VPC.
- VpcSecurityGroups []*AwsRedshiftClusterVpcSecurityGroup `type:"list"`
+ // Specifies whether the DB instance is encrypted.
+ StorageEncrypted *bool `type:"boolean"`
+
+ // The storage type for the DB instance.
+ StorageType *string `type:"string"`
+
+ // The ARN from the key store with which the instance is associated for TDE
+ // encryption.
+ TdeCredentialArn *string `type:"string"`
+
+ // The time zone of the DB instance.
+ Timezone *string `type:"string"`
+
+ // A list of VPC security groups that the DB instance belongs to.
+ VpcSecurityGroups []*AwsRdsDbInstanceVpcSecurityGroup `type:"list"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbInstanceDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbInstanceDetails) GoString() string {
+ return s.String()
+}
+
+// SetAllocatedStorage sets the AllocatedStorage field's value.
+func (s *AwsRdsDbInstanceDetails) SetAllocatedStorage(v int64) *AwsRdsDbInstanceDetails {
+ s.AllocatedStorage = &v
+ return s
+}
+
+// SetAssociatedRoles sets the AssociatedRoles field's value.
+func (s *AwsRdsDbInstanceDetails) SetAssociatedRoles(v []*AwsRdsDbInstanceAssociatedRole) *AwsRdsDbInstanceDetails {
+ s.AssociatedRoles = v
+ return s
+}
+
+// SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.
+func (s *AwsRdsDbInstanceDetails) SetAutoMinorVersionUpgrade(v bool) *AwsRdsDbInstanceDetails {
+ s.AutoMinorVersionUpgrade = &v
+ return s
+}
+
+// SetAvailabilityZone sets the AvailabilityZone field's value.
+func (s *AwsRdsDbInstanceDetails) SetAvailabilityZone(v string) *AwsRdsDbInstanceDetails {
+ s.AvailabilityZone = &v
+ return s
+}
+
+// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
+func (s *AwsRdsDbInstanceDetails) SetBackupRetentionPeriod(v int64) *AwsRdsDbInstanceDetails {
+ s.BackupRetentionPeriod = &v
+ return s
+}
+
+// SetCACertificateIdentifier sets the CACertificateIdentifier field's value.
+func (s *AwsRdsDbInstanceDetails) SetCACertificateIdentifier(v string) *AwsRdsDbInstanceDetails {
+ s.CACertificateIdentifier = &v
+ return s
+}
+
+// SetCharacterSetName sets the CharacterSetName field's value.
+func (s *AwsRdsDbInstanceDetails) SetCharacterSetName(v string) *AwsRdsDbInstanceDetails {
+ s.CharacterSetName = &v
+ return s
+}
+
+// SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.
+func (s *AwsRdsDbInstanceDetails) SetCopyTagsToSnapshot(v bool) *AwsRdsDbInstanceDetails {
+ s.CopyTagsToSnapshot = &v
+ return s
+}
+
+// SetDBClusterIdentifier sets the DBClusterIdentifier field's value.
+func (s *AwsRdsDbInstanceDetails) SetDBClusterIdentifier(v string) *AwsRdsDbInstanceDetails {
+ s.DBClusterIdentifier = &v
+ return s
+}
+
+// SetDBInstanceClass sets the DBInstanceClass field's value.
+func (s *AwsRdsDbInstanceDetails) SetDBInstanceClass(v string) *AwsRdsDbInstanceDetails {
+ s.DBInstanceClass = &v
+ return s
+}
+
+// SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.
+func (s *AwsRdsDbInstanceDetails) SetDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails {
+ s.DBInstanceIdentifier = &v
+ return s
+}
+
+// SetDBName sets the DBName field's value.
+func (s *AwsRdsDbInstanceDetails) SetDBName(v string) *AwsRdsDbInstanceDetails {
+ s.DBName = &v
+ return s
+}
+
+// SetDbInstancePort sets the DbInstancePort field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbInstancePort(v int64) *AwsRdsDbInstanceDetails {
+ s.DbInstancePort = &v
+ return s
+}
+
+// SetDbInstanceStatus sets the DbInstanceStatus field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbInstanceStatus(v string) *AwsRdsDbInstanceDetails {
+ s.DbInstanceStatus = &v
+ return s
+}
+
+// SetDbParameterGroups sets the DbParameterGroups field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbParameterGroups(v []*AwsRdsDbParameterGroup) *AwsRdsDbInstanceDetails {
+ s.DbParameterGroups = v
+ return s
+}
+
+// SetDbSecurityGroups sets the DbSecurityGroups field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbSecurityGroups(v []*string) *AwsRdsDbInstanceDetails {
+ s.DbSecurityGroups = v
+ return s
+}
+
+// SetDbSubnetGroup sets the DbSubnetGroup field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbSubnetGroup(v *AwsRdsDbSubnetGroup) *AwsRdsDbInstanceDetails {
+ s.DbSubnetGroup = v
+ return s
+}
+
+// SetDbiResourceId sets the DbiResourceId field's value.
+func (s *AwsRdsDbInstanceDetails) SetDbiResourceId(v string) *AwsRdsDbInstanceDetails {
+ s.DbiResourceId = &v
+ return s
+}
+
+// SetDeletionProtection sets the DeletionProtection field's value.
+func (s *AwsRdsDbInstanceDetails) SetDeletionProtection(v bool) *AwsRdsDbInstanceDetails {
+ s.DeletionProtection = &v
+ return s
+}
+
+// SetDomainMemberships sets the DomainMemberships field's value.
+func (s *AwsRdsDbInstanceDetails) SetDomainMemberships(v []*AwsRdsDbDomainMembership) *AwsRdsDbInstanceDetails {
+ s.DomainMemberships = v
+ return s
+}
+
+// SetEnabledCloudWatchLogsExports sets the EnabledCloudWatchLogsExports field's value.
+func (s *AwsRdsDbInstanceDetails) SetEnabledCloudWatchLogsExports(v []*string) *AwsRdsDbInstanceDetails {
+ s.EnabledCloudWatchLogsExports = v
+ return s
+}
+
+// SetEndpoint sets the Endpoint field's value.
+func (s *AwsRdsDbInstanceDetails) SetEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails {
+ s.Endpoint = v
+ return s
+}
+
+// SetEngine sets the Engine field's value.
+func (s *AwsRdsDbInstanceDetails) SetEngine(v string) *AwsRdsDbInstanceDetails {
+ s.Engine = &v
+ return s
+}
+
+// SetEngineVersion sets the EngineVersion field's value.
+func (s *AwsRdsDbInstanceDetails) SetEngineVersion(v string) *AwsRdsDbInstanceDetails {
+ s.EngineVersion = &v
+ return s
+}
+
+// SetEnhancedMonitoringResourceArn sets the EnhancedMonitoringResourceArn field's value.
+func (s *AwsRdsDbInstanceDetails) SetEnhancedMonitoringResourceArn(v string) *AwsRdsDbInstanceDetails {
+ s.EnhancedMonitoringResourceArn = &v
+ return s
+}
+
+// SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.
+func (s *AwsRdsDbInstanceDetails) SetIAMDatabaseAuthenticationEnabled(v bool) *AwsRdsDbInstanceDetails {
+ s.IAMDatabaseAuthenticationEnabled = &v
+ return s
+}
+
+// SetInstanceCreateTime sets the InstanceCreateTime field's value.
+func (s *AwsRdsDbInstanceDetails) SetInstanceCreateTime(v string) *AwsRdsDbInstanceDetails {
+ s.InstanceCreateTime = &v
+ return s
+}
+
+// SetIops sets the Iops field's value.
+func (s *AwsRdsDbInstanceDetails) SetIops(v int64) *AwsRdsDbInstanceDetails {
+ s.Iops = &v
+ return s
+}
+
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsRdsDbInstanceDetails) SetKmsKeyId(v string) *AwsRdsDbInstanceDetails {
+ s.KmsKeyId = &v
+ return s
+}
+
+// SetLatestRestorableTime sets the LatestRestorableTime field's value.
+func (s *AwsRdsDbInstanceDetails) SetLatestRestorableTime(v string) *AwsRdsDbInstanceDetails {
+ s.LatestRestorableTime = &v
+ return s
+}
+
+// SetLicenseModel sets the LicenseModel field's value.
+func (s *AwsRdsDbInstanceDetails) SetLicenseModel(v string) *AwsRdsDbInstanceDetails {
+ s.LicenseModel = &v
+ return s
+}
+
+// SetListenerEndpoint sets the ListenerEndpoint field's value.
+func (s *AwsRdsDbInstanceDetails) SetListenerEndpoint(v *AwsRdsDbInstanceEndpoint) *AwsRdsDbInstanceDetails {
+ s.ListenerEndpoint = v
+ return s
+}
+
+// SetMasterUsername sets the MasterUsername field's value.
+func (s *AwsRdsDbInstanceDetails) SetMasterUsername(v string) *AwsRdsDbInstanceDetails {
+ s.MasterUsername = &v
+ return s
+}
+
+// SetMaxAllocatedStorage sets the MaxAllocatedStorage field's value.
+func (s *AwsRdsDbInstanceDetails) SetMaxAllocatedStorage(v int64) *AwsRdsDbInstanceDetails {
+ s.MaxAllocatedStorage = &v
+ return s
+}
+
+// SetMonitoringInterval sets the MonitoringInterval field's value.
+func (s *AwsRdsDbInstanceDetails) SetMonitoringInterval(v int64) *AwsRdsDbInstanceDetails {
+ s.MonitoringInterval = &v
+ return s
+}
+
+// SetMonitoringRoleArn sets the MonitoringRoleArn field's value.
+func (s *AwsRdsDbInstanceDetails) SetMonitoringRoleArn(v string) *AwsRdsDbInstanceDetails {
+ s.MonitoringRoleArn = &v
+ return s
+}
+
+// SetMultiAz sets the MultiAz field's value.
+func (s *AwsRdsDbInstanceDetails) SetMultiAz(v bool) *AwsRdsDbInstanceDetails {
+ s.MultiAz = &v
+ return s
+}
+
+// SetOptionGroupMemberships sets the OptionGroupMemberships field's value.
+func (s *AwsRdsDbInstanceDetails) SetOptionGroupMemberships(v []*AwsRdsDbOptionGroupMembership) *AwsRdsDbInstanceDetails {
+ s.OptionGroupMemberships = v
+ return s
+}
+
+// SetPendingModifiedValues sets the PendingModifiedValues field's value.
+func (s *AwsRdsDbInstanceDetails) SetPendingModifiedValues(v *AwsRdsDbPendingModifiedValues) *AwsRdsDbInstanceDetails {
+ s.PendingModifiedValues = v
+ return s
+}
+
+// SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.
+func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsEnabled(v bool) *AwsRdsDbInstanceDetails {
+ s.PerformanceInsightsEnabled = &v
+ return s
+}
+
+// SetPerformanceInsightsKmsKeyId sets the PerformanceInsightsKmsKeyId field's value.
+func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsKmsKeyId(v string) *AwsRdsDbInstanceDetails {
+ s.PerformanceInsightsKmsKeyId = &v
+ return s
+}
+
+// SetPerformanceInsightsRetentionPeriod sets the PerformanceInsightsRetentionPeriod field's value.
+func (s *AwsRdsDbInstanceDetails) SetPerformanceInsightsRetentionPeriod(v int64) *AwsRdsDbInstanceDetails {
+ s.PerformanceInsightsRetentionPeriod = &v
+ return s
+}
+
+// SetPreferredBackupWindow sets the PreferredBackupWindow field's value.
+func (s *AwsRdsDbInstanceDetails) SetPreferredBackupWindow(v string) *AwsRdsDbInstanceDetails {
+ s.PreferredBackupWindow = &v
+ return s
+}
+
+// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
+func (s *AwsRdsDbInstanceDetails) SetPreferredMaintenanceWindow(v string) *AwsRdsDbInstanceDetails {
+ s.PreferredMaintenanceWindow = &v
+ return s
+}
+
+// SetProcessorFeatures sets the ProcessorFeatures field's value.
+func (s *AwsRdsDbInstanceDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbInstanceDetails {
+ s.ProcessorFeatures = v
+ return s
+}
+
+// SetPromotionTier sets the PromotionTier field's value.
+func (s *AwsRdsDbInstanceDetails) SetPromotionTier(v int64) *AwsRdsDbInstanceDetails {
+ s.PromotionTier = &v
+ return s
+}
+
+// SetPubliclyAccessible sets the PubliclyAccessible field's value.
+func (s *AwsRdsDbInstanceDetails) SetPubliclyAccessible(v bool) *AwsRdsDbInstanceDetails {
+ s.PubliclyAccessible = &v
+ return s
+}
+
+// SetReadReplicaDBClusterIdentifiers sets the ReadReplicaDBClusterIdentifiers field's value.
+func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBClusterIdentifiers(v []*string) *AwsRdsDbInstanceDetails {
+ s.ReadReplicaDBClusterIdentifiers = v
+ return s
+}
+
+// SetReadReplicaDBInstanceIdentifiers sets the ReadReplicaDBInstanceIdentifiers field's value.
+func (s *AwsRdsDbInstanceDetails) SetReadReplicaDBInstanceIdentifiers(v []*string) *AwsRdsDbInstanceDetails {
+ s.ReadReplicaDBInstanceIdentifiers = v
+ return s
+}
+
+// SetReadReplicaSourceDBInstanceIdentifier sets the ReadReplicaSourceDBInstanceIdentifier field's value.
+func (s *AwsRdsDbInstanceDetails) SetReadReplicaSourceDBInstanceIdentifier(v string) *AwsRdsDbInstanceDetails {
+ s.ReadReplicaSourceDBInstanceIdentifier = &v
+ return s
+}
+
+// SetSecondaryAvailabilityZone sets the SecondaryAvailabilityZone field's value.
+func (s *AwsRdsDbInstanceDetails) SetSecondaryAvailabilityZone(v string) *AwsRdsDbInstanceDetails {
+ s.SecondaryAvailabilityZone = &v
+ return s
+}
+
+// SetStatusInfos sets the StatusInfos field's value.
+func (s *AwsRdsDbInstanceDetails) SetStatusInfos(v []*AwsRdsDbStatusInfo) *AwsRdsDbInstanceDetails {
+ s.StatusInfos = v
+ return s
+}
+
+// SetStorageEncrypted sets the StorageEncrypted field's value.
+func (s *AwsRdsDbInstanceDetails) SetStorageEncrypted(v bool) *AwsRdsDbInstanceDetails {
+ s.StorageEncrypted = &v
+ return s
+}
+
+// SetStorageType sets the StorageType field's value.
+func (s *AwsRdsDbInstanceDetails) SetStorageType(v string) *AwsRdsDbInstanceDetails {
+ s.StorageType = &v
+ return s
+}
+
+// SetTdeCredentialArn sets the TdeCredentialArn field's value.
+func (s *AwsRdsDbInstanceDetails) SetTdeCredentialArn(v string) *AwsRdsDbInstanceDetails {
+ s.TdeCredentialArn = &v
+ return s
+}
+
+// SetTimezone sets the Timezone field's value.
+func (s *AwsRdsDbInstanceDetails) SetTimezone(v string) *AwsRdsDbInstanceDetails {
+ s.Timezone = &v
+ return s
+}
+
+// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
+func (s *AwsRdsDbInstanceDetails) SetVpcSecurityGroups(v []*AwsRdsDbInstanceVpcSecurityGroup) *AwsRdsDbInstanceDetails {
+ s.VpcSecurityGroups = v
+ return s
+}
+
+// Specifies the connection endpoint.
+type AwsRdsDbInstanceEndpoint struct {
+ _ struct{} `type:"structure"`
+
+ // Specifies the DNS address of the DB instance.
+ Address *string `type:"string"`
+
+ // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
+ HostedZoneId *string `type:"string"`
+
+ // Specifies the port that the database engine is listening on.
+ Port *int64 `type:"integer"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbInstanceEndpoint) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbInstanceEndpoint) GoString() string {
+ return s.String()
+}
+
+// SetAddress sets the Address field's value.
+func (s *AwsRdsDbInstanceEndpoint) SetAddress(v string) *AwsRdsDbInstanceEndpoint {
+ s.Address = &v
+ return s
+}
+
+// SetHostedZoneId sets the HostedZoneId field's value.
+func (s *AwsRdsDbInstanceEndpoint) SetHostedZoneId(v string) *AwsRdsDbInstanceEndpoint {
+ s.HostedZoneId = &v
+ return s
+}
+
+// SetPort sets the Port field's value.
+func (s *AwsRdsDbInstanceEndpoint) SetPort(v int64) *AwsRdsDbInstanceEndpoint {
+ s.Port = &v
+ return s
+}
+
+// A VPC security groups that the DB instance belongs to.
+type AwsRdsDbInstanceVpcSecurityGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The status of the VPC security group.
+ Status *string `type:"string"`
+
+ // The name of the VPC security group.
+ VpcSecurityGroupId *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbInstanceVpcSecurityGroup) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbInstanceVpcSecurityGroup) GoString() string {
+ return s.String()
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbInstanceVpcSecurityGroup) SetStatus(v string) *AwsRdsDbInstanceVpcSecurityGroup {
+ s.Status = &v
+ return s
+}
+
+// SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.
+func (s *AwsRdsDbInstanceVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRdsDbInstanceVpcSecurityGroup {
+ s.VpcSecurityGroupId = &v
+ return s
+}
+
+// An option group membership.
+type AwsRdsDbOptionGroupMembership struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the option group.
+ OptionGroupName *string `type:"string"`
+
+ // The status of the option group membership.
+ Status *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbOptionGroupMembership) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbOptionGroupMembership) GoString() string {
+ return s.String()
+}
+
+// SetOptionGroupName sets the OptionGroupName field's value.
+func (s *AwsRdsDbOptionGroupMembership) SetOptionGroupName(v string) *AwsRdsDbOptionGroupMembership {
+ s.OptionGroupName = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbOptionGroupMembership) SetStatus(v string) *AwsRdsDbOptionGroupMembership {
+ s.Status = &v
+ return s
+}
+
+// Provides information about a parameter group for a DB instance.
+type AwsRdsDbParameterGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the parameter group.
+ DbParameterGroupName *string `type:"string"`
+
+ // The status of parameter updates.
+ ParameterApplyStatus *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbParameterGroup) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbParameterGroup) GoString() string {
+ return s.String()
+}
+
+// SetDbParameterGroupName sets the DbParameterGroupName field's value.
+func (s *AwsRdsDbParameterGroup) SetDbParameterGroupName(v string) *AwsRdsDbParameterGroup {
+ s.DbParameterGroupName = &v
+ return s
+}
+
+// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
+func (s *AwsRdsDbParameterGroup) SetParameterApplyStatus(v string) *AwsRdsDbParameterGroup {
+ s.ParameterApplyStatus = &v
+ return s
+}
+
+// Changes to a DB instance that are currently pending.
+type AwsRdsDbPendingModifiedValues struct {
+ _ struct{} `type:"structure"`
+
+ // The new value of the allocated storage for the DB instance.
+ AllocatedStorage *int64 `type:"integer"`
+
+ // The new backup retention period for the DB instance.
+ BackupRetentionPeriod *int64 `type:"integer"`
+
+ // The new CA certificate identifier for the DB instance.
+ CaCertificateIdentifier *string `type:"string"`
+
+ // The new DB instance class for the DB instance.
+ DbInstanceClass *string `type:"string"`
+
+ // The new DB instance identifier for the DB instance.
+ DbInstanceIdentifier *string `type:"string"`
+
+ // The name of the new subnet group for the DB instance.
+ DbSubnetGroupName *string `type:"string"`
+
+ // The new engine version for the DB instance.
+ EngineVersion *string `type:"string"`
+
+ // The new provisioned IOPS value for the DB instance.
+ Iops *int64 `type:"integer"`
+
+ // The new license model value for the DB instance.
+ LicenseModel *string `type:"string"`
+
+ // The new master user password for the DB instance.
+ MasterUserPassword *string `type:"string"`
+
+ // Indicates that a single Availability Zone DB instance is changing to a multiple
+ // Availability Zone deployment.
+ MultiAZ *bool `type:"boolean"`
+
+ // A list of log types that are being enabled or disabled.
+ PendingCloudWatchLogsExports *AwsRdsPendingCloudWatchLogsExports `type:"structure"`
+
+ // The new port for the DB instance.
+ Port *int64 `type:"integer"`
+
+ // Processor features that are being updated.
+ ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
+
+ // The new storage type for the DB instance.
+ StorageType *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbPendingModifiedValues) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbPendingModifiedValues) GoString() string {
+ return s.String()
+}
+
+// SetAllocatedStorage sets the AllocatedStorage field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetAllocatedStorage(v int64) *AwsRdsDbPendingModifiedValues {
+ s.AllocatedStorage = &v
+ return s
+}
+
+// SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetBackupRetentionPeriod(v int64) *AwsRdsDbPendingModifiedValues {
+ s.BackupRetentionPeriod = &v
+ return s
+}
+
+// SetCaCertificateIdentifier sets the CaCertificateIdentifier field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetCaCertificateIdentifier(v string) *AwsRdsDbPendingModifiedValues {
+ s.CaCertificateIdentifier = &v
+ return s
+}
+
+// SetDbInstanceClass sets the DbInstanceClass field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceClass(v string) *AwsRdsDbPendingModifiedValues {
+ s.DbInstanceClass = &v
+ return s
+}
+
+// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetDbInstanceIdentifier(v string) *AwsRdsDbPendingModifiedValues {
+ s.DbInstanceIdentifier = &v
+ return s
+}
+
+// SetDbSubnetGroupName sets the DbSubnetGroupName field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetDbSubnetGroupName(v string) *AwsRdsDbPendingModifiedValues {
+ s.DbSubnetGroupName = &v
+ return s
+}
+
+// SetEngineVersion sets the EngineVersion field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetEngineVersion(v string) *AwsRdsDbPendingModifiedValues {
+ s.EngineVersion = &v
+ return s
+}
+
+// SetIops sets the Iops field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetIops(v int64) *AwsRdsDbPendingModifiedValues {
+ s.Iops = &v
+ return s
+}
+
+// SetLicenseModel sets the LicenseModel field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetLicenseModel(v string) *AwsRdsDbPendingModifiedValues {
+ s.LicenseModel = &v
+ return s
+}
+
+// SetMasterUserPassword sets the MasterUserPassword field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetMasterUserPassword(v string) *AwsRdsDbPendingModifiedValues {
+ s.MasterUserPassword = &v
+ return s
+}
+
+// SetMultiAZ sets the MultiAZ field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetMultiAZ(v bool) *AwsRdsDbPendingModifiedValues {
+ s.MultiAZ = &v
+ return s
+}
+
+// SetPendingCloudWatchLogsExports sets the PendingCloudWatchLogsExports field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetPendingCloudWatchLogsExports(v *AwsRdsPendingCloudWatchLogsExports) *AwsRdsDbPendingModifiedValues {
+ s.PendingCloudWatchLogsExports = v
+ return s
+}
+
+// SetPort sets the Port field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetPort(v int64) *AwsRdsDbPendingModifiedValues {
+ s.Port = &v
+ return s
+}
+
+// SetProcessorFeatures sets the ProcessorFeatures field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbPendingModifiedValues {
+ s.ProcessorFeatures = v
+ return s
+}
+
+// SetStorageType sets the StorageType field's value.
+func (s *AwsRdsDbPendingModifiedValues) SetStorageType(v string) *AwsRdsDbPendingModifiedValues {
+ s.StorageType = &v
+ return s
+}
+
+// A processor feature.
+type AwsRdsDbProcessorFeature struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the processor feature.
+ Name *string `type:"string"`
+
+ // The value of the processor feature.
+ Value *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbProcessorFeature) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbProcessorFeature) GoString() string {
+ return s.String()
+}
+
+// SetName sets the Name field's value.
+func (s *AwsRdsDbProcessorFeature) SetName(v string) *AwsRdsDbProcessorFeature {
+ s.Name = &v
+ return s
+}
+
+// SetValue sets the Value field's value.
+func (s *AwsRdsDbProcessorFeature) SetValue(v string) *AwsRdsDbProcessorFeature {
+ s.Value = &v
+ return s
+}
+
+// Provides details about an Amazon RDS DB cluster snapshot.
+type AwsRdsDbSnapshotDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The amount of storage (in gigabytes) to be initially allocated for the database
+ // instance.
+ AllocatedStorage *int64 `type:"integer"`
+
+ // Specifies the name of the Availability Zone in which the DB instance was
+ // located at the time of the DB snapshot.
+ AvailabilityZone *string `type:"string"`
+
+ // A name for the DB instance.
+ DbInstanceIdentifier *string `type:"string"`
+
+ // The name or ARN of the DB snapshot that is used to restore the DB instance.
+ DbSnapshotIdentifier *string `type:"string"`
+
+ // The identifier for the source DB instance.
+ DbiResourceId *string `type:"string"`
+
+ // Whether the DB snapshot is encrypted.
+ Encrypted *bool `type:"boolean"`
+
+ // The name of the database engine to use for this DB instance.
+ Engine *string `type:"string"`
+
+ // The version of the database engine.
+ EngineVersion *string `type:"string"`
+
+ // Whether mapping of IAM accounts to database accounts is enabled.
+ IamDatabaseAuthenticationEnabled *bool `type:"boolean"`
+
+ // Specifies the time in Coordinated Universal Time (UTC) when the DB instance,
+ // from which the snapshot was taken, was created.
+ InstanceCreateTime *string `type:"string"`
+
+ // The provisioned IOPS (I/O operations per second) value of the DB instance
+ // at the time of the snapshot.
+ Iops *int64 `type:"integer"`
+
+ // If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
+ KmsKeyId *string `type:"string"`
+
+ // License model information for the restored DB instance.
+ LicenseModel *string `type:"string"`
+
+ // The master user name for the DB snapshot.
+ MasterUsername *string `type:"string"`
+
+ // The option group name for the DB snapshot.
+ OptionGroupName *string `type:"string"`
+
+ // The percentage of the estimated data that has been transferred.
+ PercentProgress *int64 `type:"integer"`
+
+ // The port that the database engine was listening on at the time of the snapshot.
+ Port *int64 `type:"integer"`
+
+ // The number of CPU cores and the number of threads per core for the DB instance
+ // class of the DB instance.
+ ProcessorFeatures []*AwsRdsDbProcessorFeature `type:"list"`
+
+ // When the snapshot was taken in Coordinated Universal Time (UTC).
+ SnapshotCreateTime *string `type:"string"`
+
+ // The type of the DB snapshot.
+ SnapshotType *string `type:"string"`
+
+ // The DB snapshot ARN that the DB snapshot was copied from.
+ SourceDbSnapshotIdentifier *string `type:"string"`
+
+ // The AWS Region that the DB snapshot was created in or copied from.
+ SourceRegion *string `type:"string"`
+
+ // The status of this DB snapshot.
+ Status *string `type:"string"`
+
+ // The storage type associated with the DB snapshot.
+ StorageType *string `type:"string"`
+
+ // The ARN from the key store with which to associate the instance for TDE encryption.
+ TdeCredentialArn *string `type:"string"`
+
+ // The time zone of the DB snapshot.
+ Timezone *string `type:"string"`
+
+ // The VPC ID associated with the DB snapshot.
+ VpcId *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbSnapshotDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbSnapshotDetails) GoString() string {
+ return s.String()
+}
+
+// SetAllocatedStorage sets the AllocatedStorage field's value.
+func (s *AwsRdsDbSnapshotDetails) SetAllocatedStorage(v int64) *AwsRdsDbSnapshotDetails {
+ s.AllocatedStorage = &v
+ return s
+}
+
+// SetAvailabilityZone sets the AvailabilityZone field's value.
+func (s *AwsRdsDbSnapshotDetails) SetAvailabilityZone(v string) *AwsRdsDbSnapshotDetails {
+ s.AvailabilityZone = &v
+ return s
+}
+
+// SetDbInstanceIdentifier sets the DbInstanceIdentifier field's value.
+func (s *AwsRdsDbSnapshotDetails) SetDbInstanceIdentifier(v string) *AwsRdsDbSnapshotDetails {
+ s.DbInstanceIdentifier = &v
+ return s
+}
+
+// SetDbSnapshotIdentifier sets the DbSnapshotIdentifier field's value.
+func (s *AwsRdsDbSnapshotDetails) SetDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails {
+ s.DbSnapshotIdentifier = &v
+ return s
+}
+
+// SetDbiResourceId sets the DbiResourceId field's value.
+func (s *AwsRdsDbSnapshotDetails) SetDbiResourceId(v string) *AwsRdsDbSnapshotDetails {
+ s.DbiResourceId = &v
+ return s
+}
+
+// SetEncrypted sets the Encrypted field's value.
+func (s *AwsRdsDbSnapshotDetails) SetEncrypted(v bool) *AwsRdsDbSnapshotDetails {
+ s.Encrypted = &v
+ return s
+}
+
+// SetEngine sets the Engine field's value.
+func (s *AwsRdsDbSnapshotDetails) SetEngine(v string) *AwsRdsDbSnapshotDetails {
+ s.Engine = &v
+ return s
+}
+
+// SetEngineVersion sets the EngineVersion field's value.
+func (s *AwsRdsDbSnapshotDetails) SetEngineVersion(v string) *AwsRdsDbSnapshotDetails {
+ s.EngineVersion = &v
+ return s
+}
+
+// SetIamDatabaseAuthenticationEnabled sets the IamDatabaseAuthenticationEnabled field's value.
+func (s *AwsRdsDbSnapshotDetails) SetIamDatabaseAuthenticationEnabled(v bool) *AwsRdsDbSnapshotDetails {
+ s.IamDatabaseAuthenticationEnabled = &v
+ return s
+}
+
+// SetInstanceCreateTime sets the InstanceCreateTime field's value.
+func (s *AwsRdsDbSnapshotDetails) SetInstanceCreateTime(v string) *AwsRdsDbSnapshotDetails {
+ s.InstanceCreateTime = &v
+ return s
+}
+
+// SetIops sets the Iops field's value.
+func (s *AwsRdsDbSnapshotDetails) SetIops(v int64) *AwsRdsDbSnapshotDetails {
+ s.Iops = &v
+ return s
+}
+
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsRdsDbSnapshotDetails) SetKmsKeyId(v string) *AwsRdsDbSnapshotDetails {
+ s.KmsKeyId = &v
+ return s
+}
+
+// SetLicenseModel sets the LicenseModel field's value.
+func (s *AwsRdsDbSnapshotDetails) SetLicenseModel(v string) *AwsRdsDbSnapshotDetails {
+ s.LicenseModel = &v
+ return s
+}
+
+// SetMasterUsername sets the MasterUsername field's value.
+func (s *AwsRdsDbSnapshotDetails) SetMasterUsername(v string) *AwsRdsDbSnapshotDetails {
+ s.MasterUsername = &v
+ return s
+}
+
+// SetOptionGroupName sets the OptionGroupName field's value.
+func (s *AwsRdsDbSnapshotDetails) SetOptionGroupName(v string) *AwsRdsDbSnapshotDetails {
+ s.OptionGroupName = &v
+ return s
+}
+
+// SetPercentProgress sets the PercentProgress field's value.
+func (s *AwsRdsDbSnapshotDetails) SetPercentProgress(v int64) *AwsRdsDbSnapshotDetails {
+ s.PercentProgress = &v
+ return s
+}
+
+// SetPort sets the Port field's value.
+func (s *AwsRdsDbSnapshotDetails) SetPort(v int64) *AwsRdsDbSnapshotDetails {
+ s.Port = &v
+ return s
+}
+
+// SetProcessorFeatures sets the ProcessorFeatures field's value.
+func (s *AwsRdsDbSnapshotDetails) SetProcessorFeatures(v []*AwsRdsDbProcessorFeature) *AwsRdsDbSnapshotDetails {
+ s.ProcessorFeatures = v
+ return s
+}
+
+// SetSnapshotCreateTime sets the SnapshotCreateTime field's value.
+func (s *AwsRdsDbSnapshotDetails) SetSnapshotCreateTime(v string) *AwsRdsDbSnapshotDetails {
+ s.SnapshotCreateTime = &v
+ return s
+}
+
+// SetSnapshotType sets the SnapshotType field's value.
+func (s *AwsRdsDbSnapshotDetails) SetSnapshotType(v string) *AwsRdsDbSnapshotDetails {
+ s.SnapshotType = &v
+ return s
+}
+
+// SetSourceDbSnapshotIdentifier sets the SourceDbSnapshotIdentifier field's value.
+func (s *AwsRdsDbSnapshotDetails) SetSourceDbSnapshotIdentifier(v string) *AwsRdsDbSnapshotDetails {
+ s.SourceDbSnapshotIdentifier = &v
+ return s
+}
+
+// SetSourceRegion sets the SourceRegion field's value.
+func (s *AwsRdsDbSnapshotDetails) SetSourceRegion(v string) *AwsRdsDbSnapshotDetails {
+ s.SourceRegion = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbSnapshotDetails) SetStatus(v string) *AwsRdsDbSnapshotDetails {
+ s.Status = &v
+ return s
+}
+
+// SetStorageType sets the StorageType field's value.
+func (s *AwsRdsDbSnapshotDetails) SetStorageType(v string) *AwsRdsDbSnapshotDetails {
+ s.StorageType = &v
+ return s
+}
+
+// SetTdeCredentialArn sets the TdeCredentialArn field's value.
+func (s *AwsRdsDbSnapshotDetails) SetTdeCredentialArn(v string) *AwsRdsDbSnapshotDetails {
+ s.TdeCredentialArn = &v
+ return s
+}
+
+// SetTimezone sets the Timezone field's value.
+func (s *AwsRdsDbSnapshotDetails) SetTimezone(v string) *AwsRdsDbSnapshotDetails {
+ s.Timezone = &v
+ return s
+}
+
+// SetVpcId sets the VpcId field's value.
+func (s *AwsRdsDbSnapshotDetails) SetVpcId(v string) *AwsRdsDbSnapshotDetails {
+ s.VpcId = &v
+ return s
+}
+
+// Information about the status of a read replica.
+type AwsRdsDbStatusInfo struct {
+ _ struct{} `type:"structure"`
+
+ // If the read replica is currently in an error state, provides the error details.
+ Message *string `type:"string"`
+
+ // Whether the read replica instance is operating normally.
+ Normal *bool `type:"boolean"`
+
+ // The status of the read replica instance.
+ Status *string `type:"string"`
+
+ // The type of status. For a read replica, the status type is read replication.
+ StatusType *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbStatusInfo) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbStatusInfo) GoString() string {
+ return s.String()
+}
+
+// SetMessage sets the Message field's value.
+func (s *AwsRdsDbStatusInfo) SetMessage(v string) *AwsRdsDbStatusInfo {
+ s.Message = &v
+ return s
+}
+
+// SetNormal sets the Normal field's value.
+func (s *AwsRdsDbStatusInfo) SetNormal(v bool) *AwsRdsDbStatusInfo {
+ s.Normal = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRdsDbStatusInfo) SetStatus(v string) *AwsRdsDbStatusInfo {
+ s.Status = &v
+ return s
+}
+
+// SetStatusType sets the StatusType field's value.
+func (s *AwsRdsDbStatusInfo) SetStatusType(v string) *AwsRdsDbStatusInfo {
+ s.StatusType = &v
+ return s
+}
+
+// Information about the subnet group for the database instance.
+type AwsRdsDbSubnetGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The ARN of the subnet group.
+ DbSubnetGroupArn *string `type:"string"`
+
+ // The description of the subnet group.
+ DbSubnetGroupDescription *string `type:"string"`
+
+ // The name of the subnet group.
+ DbSubnetGroupName *string `type:"string"`
+
+ // The status of the subnet group.
+ SubnetGroupStatus *string `type:"string"`
+
+ // A list of subnets in the subnet group.
+ Subnets []*AwsRdsDbSubnetGroupSubnet `type:"list"`
+
+ // The VPC ID of the subnet group.
+ VpcId *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbSubnetGroup) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbSubnetGroup) GoString() string {
+ return s.String()
+}
+
+// SetDbSubnetGroupArn sets the DbSubnetGroupArn field's value.
+func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupArn(v string) *AwsRdsDbSubnetGroup {
+ s.DbSubnetGroupArn = &v
+ return s
+}
+
+// SetDbSubnetGroupDescription sets the DbSubnetGroupDescription field's value.
+func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupDescription(v string) *AwsRdsDbSubnetGroup {
+ s.DbSubnetGroupDescription = &v
+ return s
+}
+
+// SetDbSubnetGroupName sets the DbSubnetGroupName field's value.
+func (s *AwsRdsDbSubnetGroup) SetDbSubnetGroupName(v string) *AwsRdsDbSubnetGroup {
+ s.DbSubnetGroupName = &v
+ return s
+}
+
+// SetSubnetGroupStatus sets the SubnetGroupStatus field's value.
+func (s *AwsRdsDbSubnetGroup) SetSubnetGroupStatus(v string) *AwsRdsDbSubnetGroup {
+ s.SubnetGroupStatus = &v
+ return s
+}
+
+// SetSubnets sets the Subnets field's value.
+func (s *AwsRdsDbSubnetGroup) SetSubnets(v []*AwsRdsDbSubnetGroupSubnet) *AwsRdsDbSubnetGroup {
+ s.Subnets = v
+ return s
+}
+
+// SetVpcId sets the VpcId field's value.
+func (s *AwsRdsDbSubnetGroup) SetVpcId(v string) *AwsRdsDbSubnetGroup {
+ s.VpcId = &v
+ return s
+}
+
+// Information about a subnet in a subnet group.
+type AwsRdsDbSubnetGroupSubnet struct {
+ _ struct{} `type:"structure"`
+
+ // Information about the Availability Zone for a subnet in the subnet group.
+ SubnetAvailabilityZone *AwsRdsDbSubnetGroupSubnetAvailabilityZone `type:"structure"`
+
+ // The identifier of a subnet in the subnet group.
+ SubnetIdentifier *string `type:"string"`
+
+ // The status of a subnet in the subnet group.
+ SubnetStatus *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbSubnetGroupSubnet) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbSubnetGroupSubnet) GoString() string {
+ return s.String()
+}
+
+// SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.
+func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetAvailabilityZone(v *AwsRdsDbSubnetGroupSubnetAvailabilityZone) *AwsRdsDbSubnetGroupSubnet {
+ s.SubnetAvailabilityZone = v
+ return s
+}
+
+// SetSubnetIdentifier sets the SubnetIdentifier field's value.
+func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetIdentifier(v string) *AwsRdsDbSubnetGroupSubnet {
+ s.SubnetIdentifier = &v
+ return s
+}
+
+// SetSubnetStatus sets the SubnetStatus field's value.
+func (s *AwsRdsDbSubnetGroupSubnet) SetSubnetStatus(v string) *AwsRdsDbSubnetGroupSubnet {
+ s.SubnetStatus = &v
+ return s
+}
+
+// An Availability Zone for a subnet in a subnet group.
+type AwsRdsDbSubnetGroupSubnetAvailabilityZone struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the Availability Zone for a subnet in the subnet group.
+ Name *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsDbSubnetGroupSubnetAvailabilityZone) GoString() string {
+ return s.String()
+}
+
+// SetName sets the Name field's value.
+func (s *AwsRdsDbSubnetGroupSubnetAvailabilityZone) SetName(v string) *AwsRdsDbSubnetGroupSubnetAvailabilityZone {
+ s.Name = &v
+ return s
+}
+
+// Identifies the log types to enable and disable.
+type AwsRdsPendingCloudWatchLogsExports struct {
+ _ struct{} `type:"structure"`
+
+ // A list of log types that are being disabled.
+ LogTypesToDisable []*string `type:"list"`
+
+ // A list of log types that are being enabled.
+ LogTypesToEnable []*string `type:"list"`
+}
+
+// String returns the string representation
+func (s AwsRdsPendingCloudWatchLogsExports) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRdsPendingCloudWatchLogsExports) GoString() string {
+ return s.String()
+}
+
+// SetLogTypesToDisable sets the LogTypesToDisable field's value.
+func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToDisable(v []*string) *AwsRdsPendingCloudWatchLogsExports {
+ s.LogTypesToDisable = v
+ return s
+}
+
+// SetLogTypesToEnable sets the LogTypesToEnable field's value.
+func (s *AwsRdsPendingCloudWatchLogsExports) SetLogTypesToEnable(v []*string) *AwsRdsPendingCloudWatchLogsExports {
+ s.LogTypesToEnable = v
+ return s
+}
+
+// A node in an Amazon Redshift cluster.
+type AwsRedshiftClusterClusterNode struct {
+ _ struct{} `type:"structure"`
+
+ // The role of the node. A node might be a leader node or a compute node.
+ NodeRole *string `type:"string"`
+
+ // The private IP address of the node.
+ PrivateIpAddress *string `type:"string"`
+
+ // The public IP address of the node.
+ PublicIpAddress *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterClusterNode) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterClusterNode) GoString() string {
+ return s.String()
+}
+
+// SetNodeRole sets the NodeRole field's value.
+func (s *AwsRedshiftClusterClusterNode) SetNodeRole(v string) *AwsRedshiftClusterClusterNode {
+ s.NodeRole = &v
+ return s
+}
+
+// SetPrivateIpAddress sets the PrivateIpAddress field's value.
+func (s *AwsRedshiftClusterClusterNode) SetPrivateIpAddress(v string) *AwsRedshiftClusterClusterNode {
+ s.PrivateIpAddress = &v
+ return s
+}
+
+// SetPublicIpAddress sets the PublicIpAddress field's value.
+func (s *AwsRedshiftClusterClusterNode) SetPublicIpAddress(v string) *AwsRedshiftClusterClusterNode {
+ s.PublicIpAddress = &v
+ return s
+}
+
+// A cluster parameter group that is associated with an Amazon Redshift cluster.
+type AwsRedshiftClusterClusterParameterGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The list of parameter statuses.
+ ClusterParameterStatusList []*AwsRedshiftClusterClusterParameterStatus `type:"list"`
+
+ // The status of updates to the parameters.
+ ParameterApplyStatus *string `type:"string"`
+
+ // The name of the parameter group.
+ ParameterGroupName *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterClusterParameterGroup) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterClusterParameterGroup) GoString() string {
+ return s.String()
+}
+
+// SetClusterParameterStatusList sets the ClusterParameterStatusList field's value.
+func (s *AwsRedshiftClusterClusterParameterGroup) SetClusterParameterStatusList(v []*AwsRedshiftClusterClusterParameterStatus) *AwsRedshiftClusterClusterParameterGroup {
+ s.ClusterParameterStatusList = v
+ return s
+}
+
+// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
+func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterGroup {
+ s.ParameterApplyStatus = &v
+ return s
+}
+
+// SetParameterGroupName sets the ParameterGroupName field's value.
+func (s *AwsRedshiftClusterClusterParameterGroup) SetParameterGroupName(v string) *AwsRedshiftClusterClusterParameterGroup {
+ s.ParameterGroupName = &v
+ return s
+}
+
+// The status of a parameter in a cluster parameter group for an Amazon Redshift
+// cluster.
+type AwsRedshiftClusterClusterParameterStatus struct {
+ _ struct{} `type:"structure"`
+
+ // The error that prevented the parameter from being applied to the database.
+ ParameterApplyErrorDescription *string `type:"string"`
+
+ // The status of the parameter. Indicates whether the parameter is in sync with
+ // the database, waiting for a cluster reboot, or encountered an error when
+ // it was applied.
+ //
+ // Valid values: in-sync | pending-reboot | applying | invalid-parameter | apply-deferred
+ // | apply-error | unknown-error
+ ParameterApplyStatus *string `type:"string"`
+
+ // The name of the parameter.
+ ParameterName *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterClusterParameterStatus) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterClusterParameterStatus) GoString() string {
+ return s.String()
+}
+
+// SetParameterApplyErrorDescription sets the ParameterApplyErrorDescription field's value.
+func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyErrorDescription(v string) *AwsRedshiftClusterClusterParameterStatus {
+ s.ParameterApplyErrorDescription = &v
+ return s
+}
+
+// SetParameterApplyStatus sets the ParameterApplyStatus field's value.
+func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterApplyStatus(v string) *AwsRedshiftClusterClusterParameterStatus {
+ s.ParameterApplyStatus = &v
+ return s
+}
+
+// SetParameterName sets the ParameterName field's value.
+func (s *AwsRedshiftClusterClusterParameterStatus) SetParameterName(v string) *AwsRedshiftClusterClusterParameterStatus {
+ s.ParameterName = &v
+ return s
+}
+
+// A security group that is associated with the cluster.
+type AwsRedshiftClusterClusterSecurityGroup struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the cluster security group.
+ ClusterSecurityGroupName *string `type:"string"`
+
+ // The status of the cluster security group.
+ Status *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterClusterSecurityGroup) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterClusterSecurityGroup) GoString() string {
+ return s.String()
+}
+
+// SetClusterSecurityGroupName sets the ClusterSecurityGroupName field's value.
+func (s *AwsRedshiftClusterClusterSecurityGroup) SetClusterSecurityGroupName(v string) *AwsRedshiftClusterClusterSecurityGroup {
+ s.ClusterSecurityGroupName = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRedshiftClusterClusterSecurityGroup) SetStatus(v string) *AwsRedshiftClusterClusterSecurityGroup {
+ s.Status = &v
+ return s
+}
+
+// Information about a cross-Region snapshot copy.
+type AwsRedshiftClusterClusterSnapshotCopyStatus struct {
+ _ struct{} `type:"structure"`
+
+ // The destination Region that snapshots are automatically copied to when cross-Region
+ // snapshot copy is enabled.
+ DestinationRegion *string `type:"string"`
+
+ // The number of days that manual snapshots are retained in the destination
+ // region after they are copied from a source region.
+ //
+ // If the value is -1, then the manual snapshot is retained indefinitely.
+ //
+ // Valid values: Either -1 or an integer between 1 and 3,653
+ ManualSnapshotRetentionPeriod *int64 `type:"integer"`
+
+ // The number of days to retain automated snapshots in the destination Region
+ // after they are copied from a source Region.
+ RetentionPeriod *int64 `type:"integer"`
+
+ // The name of the snapshot copy grant.
+ SnapshotCopyGrantName *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterClusterSnapshotCopyStatus) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterClusterSnapshotCopyStatus) GoString() string {
+ return s.String()
+}
+
+// SetDestinationRegion sets the DestinationRegion field's value.
+func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetDestinationRegion(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus {
+ s.DestinationRegion = &v
+ return s
+}
+
+// SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.
+func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus {
+ s.ManualSnapshotRetentionPeriod = &v
+ return s
+}
+
+// SetRetentionPeriod sets the RetentionPeriod field's value.
+func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetRetentionPeriod(v int64) *AwsRedshiftClusterClusterSnapshotCopyStatus {
+ s.RetentionPeriod = &v
+ return s
+}
+
+// SetSnapshotCopyGrantName sets the SnapshotCopyGrantName field's value.
+func (s *AwsRedshiftClusterClusterSnapshotCopyStatus) SetSnapshotCopyGrantName(v string) *AwsRedshiftClusterClusterSnapshotCopyStatus {
+ s.SnapshotCopyGrantName = &v
+ return s
+}
+
+// A time windows during which maintenance was deferred for an Amazon Redshift
+// cluster.
+type AwsRedshiftClusterDeferredMaintenanceWindow struct {
+ _ struct{} `type:"structure"`
+
+ // The end of the time window for which maintenance was deferred.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ DeferMaintenanceEndTime *string `type:"string"`
+
+ // The identifier of the maintenance window.
+ DeferMaintenanceIdentifier *string `type:"string"`
+
+ // The start of the time window for which maintenance was deferred.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ DeferMaintenanceStartTime *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterDeferredMaintenanceWindow) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterDeferredMaintenanceWindow) GoString() string {
+ return s.String()
+}
+
+// SetDeferMaintenanceEndTime sets the DeferMaintenanceEndTime field's value.
+func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceEndTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
+ s.DeferMaintenanceEndTime = &v
+ return s
+}
+
+// SetDeferMaintenanceIdentifier sets the DeferMaintenanceIdentifier field's value.
+func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceIdentifier(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
+ s.DeferMaintenanceIdentifier = &v
+ return s
+}
+
+// SetDeferMaintenanceStartTime sets the DeferMaintenanceStartTime field's value.
+func (s *AwsRedshiftClusterDeferredMaintenanceWindow) SetDeferMaintenanceStartTime(v string) *AwsRedshiftClusterDeferredMaintenanceWindow {
+ s.DeferMaintenanceStartTime = &v
+ return s
+}
+
+// Details about an Amazon Redshift cluster.
+type AwsRedshiftClusterDetails struct {
+ _ struct{} `type:"structure"`
+
+ // Indicates whether major version upgrades are applied automatically to the
+ // cluster during the maintenance window.
+ AllowVersionUpgrade *bool `type:"boolean"`
+
+ // The number of days that automatic cluster snapshots are retained.
+ AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`
+
+ // The name of the Availability Zone in which the cluster is located.
+ AvailabilityZone *string `type:"string"`
+
+ // The availability status of the cluster for queries. Possible values are the
+ // following:
+ //
+ // * Available - The cluster is available for queries.
+ //
+ // * Unavailable - The cluster is not available for queries.
+ //
+ // * Maintenance - The cluster is intermittently available for queries due
+ // to maintenance activities.
+ //
+ // * Modifying -The cluster is intermittently available for queries due to
+ // changes that modify the cluster.
+ //
+ // * Failed - The cluster failed and is not available for queries.
+ ClusterAvailabilityStatus *string `type:"string"`
+
+ // Indicates when the cluster was created.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ ClusterCreateTime *string `type:"string"`
+
+ // The unique identifier of the cluster.
+ ClusterIdentifier *string `type:"string"`
+
+ // The nodes in the cluster.
+ ClusterNodes []*AwsRedshiftClusterClusterNode `type:"list"`
+
+ // The list of cluster parameter groups that are associated with this cluster.
+ ClusterParameterGroups []*AwsRedshiftClusterClusterParameterGroup `type:"list"`
+
+ // The public key for the cluster.
+ ClusterPublicKey *string `type:"string"`
+
+ // The specific revision number of the database in the cluster.
+ ClusterRevisionNumber *string `type:"string"`
+
+ // A list of cluster security groups that are associated with the cluster.
+ ClusterSecurityGroups []*AwsRedshiftClusterClusterSecurityGroup `type:"list"`
+
+ // Information about the destination Region and retention period for the cross-Region
+ // snapshot copy.
+ ClusterSnapshotCopyStatus *AwsRedshiftClusterClusterSnapshotCopyStatus `type:"structure"`
+
+ // The current status of the cluster.
+ //
+ // Valid values: available | available, prep-for-resize | available, resize-cleanup
+ // |cancelling-resize | creating | deleting | final-snapshot | hardware-failure
+ // | incompatible-hsm |incompatible-network | incompatible-parameters | incompatible-restore
+ // | modifying | paused | rebooting | renaming | resizing | rotating-keys |
+ // storage-full | updating-hsm
+ ClusterStatus *string `type:"string"`
+
+ // The name of the subnet group that is associated with the cluster. This parameter
+ // is valid only when the cluster is in a VPC.
+ ClusterSubnetGroupName *string `type:"string"`
+
+ // The version ID of the Amazon Redshift engine that runs on the cluster.
+ ClusterVersion *string `type:"string"`
+
+ // The name of the initial database that was created when the cluster was created.
+ //
+ // The same name is returned for the life of the cluster.
+ //
+ // If an initial database is not specified, a database named devdev is created
+ // by default.
+ DBName *string `type:"string"`
+
+ // List of time windows during which maintenance was deferred.
+ DeferredMaintenanceWindows []*AwsRedshiftClusterDeferredMaintenanceWindow `type:"list"`
+
+ // Information about the status of the Elastic IP (EIP) address.
+ ElasticIpStatus *AwsRedshiftClusterElasticIpStatus `type:"structure"`
+
+ // The number of nodes that you can use the elastic resize method to resize
+ // the cluster to.
+ ElasticResizeNumberOfNodeOptions *string `type:"string"`
+
+ // Indicates whether the data in the cluster is encrypted at rest.
+ Encrypted *bool `type:"boolean"`
+
+ // The connection endpoint.
+ Endpoint *AwsRedshiftClusterEndpoint `type:"structure"`
+
+ // Indicates whether to create the cluster with enhanced VPC routing enabled.
+ EnhancedVpcRouting *bool `type:"boolean"`
+
+ // Indicates when the next snapshot is expected to be taken. The cluster must
+ // have a valid snapshot schedule and have backups enabled.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ ExpectedNextSnapshotScheduleTime *string `type:"string"`
+
+ // The status of the next expected snapshot.
+ //
+ // Valid values: OnTrack | Pending
+ ExpectedNextSnapshotScheduleTimeStatus *string `type:"string"`
+
+ // Information about whether the Amazon Redshift cluster finished applying any
+ // changes to hardware security module (HSM) settings that were specified in
+ // a modify cluster command.
+ HsmStatus *AwsRedshiftClusterHsmStatus `type:"structure"`
+
+ // A list of IAM roles that the cluster can use to access other AWS services.
+ IamRoles []*AwsRedshiftClusterIamRole `type:"list"`
+
+ // The identifier of the AWS KMS encryption key that is used to encrypt data
+ // in the cluster.
+ KmsKeyId *string `type:"string"`
+
+ // The name of the maintenance track for the cluster.
+ MaintenanceTrackName *string `type:"string"`
+
+ // The default number of days to retain a manual snapshot.
+ //
+ // If the value is -1, the snapshot is retained indefinitely.
+ //
+ // This setting doesn't change the retention period of existing snapshots.
+ //
+ // Valid values: Either -1 or an integer between 1 and 3,653
+ ManualSnapshotRetentionPeriod *int64 `type:"integer"`
+
+ // The master user name for the cluster. This name is used to connect to the
+ // database that is specified in as the value of DBName.
+ MasterUsername *string `type:"string"`
+
+ // Indicates the start of the next maintenance window.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ NextMaintenanceWindowStartTime *string `type:"string"`
+
+ // The node type for the nodes in the cluster.
+ NodeType *string `type:"string"`
+
+ // The number of compute nodes in the cluster.
+ NumberOfNodes *int64 `type:"integer"`
+
+ // A list of cluster operations that are waiting to start.
+ PendingActions []*string `type:"list"`
+
+ // A list of changes to the cluster that are currently pending.
+ PendingModifiedValues *AwsRedshiftClusterPendingModifiedValues `type:"structure"`
+
+ // The weekly time range, in Universal Coordinated Time (UTC), during which
+ // system maintenance can occur.
+ //
+ // Format: :HH:MM-:HH:MM
+ //
+ // For the day values, use mon | tue | wed | thu | fri | sat | sun
+ //
+ // For example, sun:09:32-sun:10:02
+ PreferredMaintenanceWindow *string `type:"string"`
+
+ // Whether the cluster can be accessed from a public network.
+ PubliclyAccessible *bool `type:"boolean"`
+
+ // Information about the resize operation for the cluster.
+ ResizeInfo *AwsRedshiftClusterResizeInfo `type:"structure"`
+
+ // Information about the status of a cluster restore action. Only applies to
+ // a cluster that was created by restoring a snapshot.
+ RestoreStatus *AwsRedshiftClusterRestoreStatus `type:"structure"`
+
+ // A unique identifier for the cluster snapshot schedule.
+ SnapshotScheduleIdentifier *string `type:"string"`
+
+ // The current state of the cluster snapshot schedule.
+ //
+ // Valid values: MODIFYING | ACTIVE | FAILED
+ SnapshotScheduleState *string `type:"string"`
+
+ // The identifier of the VPC that the cluster is in, if the cluster is in a
+ // VPC.
+ VpcId *string `type:"string"`
+
+ // The list of VPC security groups that the cluster belongs to, if the cluster
+ // is in a VPC.
+ VpcSecurityGroups []*AwsRedshiftClusterVpcSecurityGroup `type:"list"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterDetails) GoString() string {
+ return s.String()
+}
+
+// SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.
+func (s *AwsRedshiftClusterDetails) SetAllowVersionUpgrade(v bool) *AwsRedshiftClusterDetails {
+ s.AllowVersionUpgrade = &v
+ return s
+}
+
+// SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.
+func (s *AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails {
+ s.AutomatedSnapshotRetentionPeriod = &v
+ return s
+}
+
+// SetAvailabilityZone sets the AvailabilityZone field's value.
+func (s *AwsRedshiftClusterDetails) SetAvailabilityZone(v string) *AwsRedshiftClusterDetails {
+ s.AvailabilityZone = &v
+ return s
+}
+
+// SetClusterAvailabilityStatus sets the ClusterAvailabilityStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterAvailabilityStatus(v string) *AwsRedshiftClusterDetails {
+ s.ClusterAvailabilityStatus = &v
+ return s
+}
+
+// SetClusterCreateTime sets the ClusterCreateTime field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterCreateTime(v string) *AwsRedshiftClusterDetails {
+ s.ClusterCreateTime = &v
+ return s
+}
+
+// SetClusterIdentifier sets the ClusterIdentifier field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterIdentifier(v string) *AwsRedshiftClusterDetails {
+ s.ClusterIdentifier = &v
+ return s
+}
+
+// SetClusterNodes sets the ClusterNodes field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterNodes(v []*AwsRedshiftClusterClusterNode) *AwsRedshiftClusterDetails {
+ s.ClusterNodes = v
+ return s
+}
+
+// SetClusterParameterGroups sets the ClusterParameterGroups field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterParameterGroups(v []*AwsRedshiftClusterClusterParameterGroup) *AwsRedshiftClusterDetails {
+ s.ClusterParameterGroups = v
+ return s
+}
+
+// SetClusterPublicKey sets the ClusterPublicKey field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterPublicKey(v string) *AwsRedshiftClusterDetails {
+ s.ClusterPublicKey = &v
+ return s
+}
+
+// SetClusterRevisionNumber sets the ClusterRevisionNumber field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterRevisionNumber(v string) *AwsRedshiftClusterDetails {
+ s.ClusterRevisionNumber = &v
+ return s
+}
+
+// SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterSecurityGroups(v []*AwsRedshiftClusterClusterSecurityGroup) *AwsRedshiftClusterDetails {
+ s.ClusterSecurityGroups = v
+ return s
+}
+
+// SetClusterSnapshotCopyStatus sets the ClusterSnapshotCopyStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterSnapshotCopyStatus(v *AwsRedshiftClusterClusterSnapshotCopyStatus) *AwsRedshiftClusterDetails {
+ s.ClusterSnapshotCopyStatus = v
+ return s
+}
+
+// SetClusterStatus sets the ClusterStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterStatus(v string) *AwsRedshiftClusterDetails {
+ s.ClusterStatus = &v
+ return s
+}
+
+// SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterSubnetGroupName(v string) *AwsRedshiftClusterDetails {
+ s.ClusterSubnetGroupName = &v
+ return s
+}
+
+// SetClusterVersion sets the ClusterVersion field's value.
+func (s *AwsRedshiftClusterDetails) SetClusterVersion(v string) *AwsRedshiftClusterDetails {
+ s.ClusterVersion = &v
+ return s
+}
+
+// SetDBName sets the DBName field's value.
+func (s *AwsRedshiftClusterDetails) SetDBName(v string) *AwsRedshiftClusterDetails {
+ s.DBName = &v
+ return s
+}
+
+// SetDeferredMaintenanceWindows sets the DeferredMaintenanceWindows field's value.
+func (s *AwsRedshiftClusterDetails) SetDeferredMaintenanceWindows(v []*AwsRedshiftClusterDeferredMaintenanceWindow) *AwsRedshiftClusterDetails {
+ s.DeferredMaintenanceWindows = v
+ return s
+}
+
+// SetElasticIpStatus sets the ElasticIpStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetElasticIpStatus(v *AwsRedshiftClusterElasticIpStatus) *AwsRedshiftClusterDetails {
+ s.ElasticIpStatus = v
+ return s
+}
+
+// SetElasticResizeNumberOfNodeOptions sets the ElasticResizeNumberOfNodeOptions field's value.
+func (s *AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions(v string) *AwsRedshiftClusterDetails {
+ s.ElasticResizeNumberOfNodeOptions = &v
+ return s
+}
+
+// SetEncrypted sets the Encrypted field's value.
+func (s *AwsRedshiftClusterDetails) SetEncrypted(v bool) *AwsRedshiftClusterDetails {
+ s.Encrypted = &v
+ return s
+}
+
+// SetEndpoint sets the Endpoint field's value.
+func (s *AwsRedshiftClusterDetails) SetEndpoint(v *AwsRedshiftClusterEndpoint) *AwsRedshiftClusterDetails {
+ s.Endpoint = v
+ return s
+}
+
+// SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.
+func (s *AwsRedshiftClusterDetails) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterDetails {
+ s.EnhancedVpcRouting = &v
+ return s
+}
+
+// SetExpectedNextSnapshotScheduleTime sets the ExpectedNextSnapshotScheduleTime field's value.
+func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime(v string) *AwsRedshiftClusterDetails {
+ s.ExpectedNextSnapshotScheduleTime = &v
+ return s
+}
+
+// SetExpectedNextSnapshotScheduleTimeStatus sets the ExpectedNextSnapshotScheduleTimeStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus(v string) *AwsRedshiftClusterDetails {
+ s.ExpectedNextSnapshotScheduleTimeStatus = &v
+ return s
+}
+
+// SetHsmStatus sets the HsmStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetHsmStatus(v *AwsRedshiftClusterHsmStatus) *AwsRedshiftClusterDetails {
+ s.HsmStatus = v
+ return s
+}
+
+// SetIamRoles sets the IamRoles field's value.
+func (s *AwsRedshiftClusterDetails) SetIamRoles(v []*AwsRedshiftClusterIamRole) *AwsRedshiftClusterDetails {
+ s.IamRoles = v
+ return s
+}
+
+// SetKmsKeyId sets the KmsKeyId field's value.
+func (s *AwsRedshiftClusterDetails) SetKmsKeyId(v string) *AwsRedshiftClusterDetails {
+ s.KmsKeyId = &v
+ return s
+}
+
+// SetMaintenanceTrackName sets the MaintenanceTrackName field's value.
+func (s *AwsRedshiftClusterDetails) SetMaintenanceTrackName(v string) *AwsRedshiftClusterDetails {
+ s.MaintenanceTrackName = &v
+ return s
+}
+
+// SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.
+func (s *AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails {
+ s.ManualSnapshotRetentionPeriod = &v
+ return s
+}
+
+// SetMasterUsername sets the MasterUsername field's value.
+func (s *AwsRedshiftClusterDetails) SetMasterUsername(v string) *AwsRedshiftClusterDetails {
+ s.MasterUsername = &v
+ return s
+}
+
+// SetNextMaintenanceWindowStartTime sets the NextMaintenanceWindowStartTime field's value.
+func (s *AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime(v string) *AwsRedshiftClusterDetails {
+ s.NextMaintenanceWindowStartTime = &v
+ return s
+}
+
+// SetNodeType sets the NodeType field's value.
+func (s *AwsRedshiftClusterDetails) SetNodeType(v string) *AwsRedshiftClusterDetails {
+ s.NodeType = &v
+ return s
+}
+
+// SetNumberOfNodes sets the NumberOfNodes field's value.
+func (s *AwsRedshiftClusterDetails) SetNumberOfNodes(v int64) *AwsRedshiftClusterDetails {
+ s.NumberOfNodes = &v
+ return s
+}
+
+// SetPendingActions sets the PendingActions field's value.
+func (s *AwsRedshiftClusterDetails) SetPendingActions(v []*string) *AwsRedshiftClusterDetails {
+ s.PendingActions = v
+ return s
+}
+
+// SetPendingModifiedValues sets the PendingModifiedValues field's value.
+func (s *AwsRedshiftClusterDetails) SetPendingModifiedValues(v *AwsRedshiftClusterPendingModifiedValues) *AwsRedshiftClusterDetails {
+ s.PendingModifiedValues = v
+ return s
+}
+
+// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
+func (s *AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRedshiftClusterDetails {
+ s.PreferredMaintenanceWindow = &v
+ return s
+}
+
+// SetPubliclyAccessible sets the PubliclyAccessible field's value.
+func (s *AwsRedshiftClusterDetails) SetPubliclyAccessible(v bool) *AwsRedshiftClusterDetails {
+ s.PubliclyAccessible = &v
+ return s
+}
+
+// SetResizeInfo sets the ResizeInfo field's value.
+func (s *AwsRedshiftClusterDetails) SetResizeInfo(v *AwsRedshiftClusterResizeInfo) *AwsRedshiftClusterDetails {
+ s.ResizeInfo = v
+ return s
+}
+
+// SetRestoreStatus sets the RestoreStatus field's value.
+func (s *AwsRedshiftClusterDetails) SetRestoreStatus(v *AwsRedshiftClusterRestoreStatus) *AwsRedshiftClusterDetails {
+ s.RestoreStatus = v
+ return s
+}
+
+// SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.
+func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier(v string) *AwsRedshiftClusterDetails {
+ s.SnapshotScheduleIdentifier = &v
+ return s
+}
+
+// SetSnapshotScheduleState sets the SnapshotScheduleState field's value.
+func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleState(v string) *AwsRedshiftClusterDetails {
+ s.SnapshotScheduleState = &v
+ return s
+}
+
+// SetVpcId sets the VpcId field's value.
+func (s *AwsRedshiftClusterDetails) SetVpcId(v string) *AwsRedshiftClusterDetails {
+ s.VpcId = &v
+ return s
+}
+
+// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
+func (s *AwsRedshiftClusterDetails) SetVpcSecurityGroups(v []*AwsRedshiftClusterVpcSecurityGroup) *AwsRedshiftClusterDetails {
+ s.VpcSecurityGroups = v
+ return s
+}
+
+// The status of the elastic IP (EIP) address for an Amazon Redshift cluster.
+type AwsRedshiftClusterElasticIpStatus struct {
+ _ struct{} `type:"structure"`
+
+ // The elastic IP address for the cluster.
+ ElasticIp *string `type:"string"`
+
+ // The status of the elastic IP address.
+ Status *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterElasticIpStatus) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterElasticIpStatus) GoString() string {
+ return s.String()
+}
+
+// SetElasticIp sets the ElasticIp field's value.
+func (s *AwsRedshiftClusterElasticIpStatus) SetElasticIp(v string) *AwsRedshiftClusterElasticIpStatus {
+ s.ElasticIp = &v
+ return s
+}
+
+// SetStatus sets the Status field's value.
+func (s *AwsRedshiftClusterElasticIpStatus) SetStatus(v string) *AwsRedshiftClusterElasticIpStatus {
+ s.Status = &v
+ return s
+}
+
+// The connection endpoint for an Amazon Redshift cluster.
+type AwsRedshiftClusterEndpoint struct {
+ _ struct{} `type:"structure"`
+
+ // The DNS address of the cluster.
+ Address *string `type:"string"`
+
+ // The port that the database engine listens on.
+ Port *int64 `type:"integer"`
+}
+
+// String returns the string representation
+func (s AwsRedshiftClusterEndpoint) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsRedshiftClusterEndpoint) GoString() string {
+ return s.String()
+}
+
+// SetAddress sets the Address field's value.
+func (s *AwsRedshiftClusterEndpoint) SetAddress(v string) *AwsRedshiftClusterEndpoint {
+ s.Address = &v
+ return s
+}
+
+// SetPort sets the Port field's value.
+func (s *AwsRedshiftClusterEndpoint) SetPort(v int64) *AwsRedshiftClusterEndpoint {
+ s.Port = &v
+ return s
+}
+
+// Information about whether an Amazon Redshift cluster finished applying any
+// hardware changes to security module (HSM) settings that were specified in
+// a modify cluster command.
+type AwsRedshiftClusterHsmStatus struct {
+ _ struct{} `type:"structure"`
+
+ // The name of the HSM client certificate that the Amazon Redshift cluster uses
+ // to retrieve the data encryption keys that are stored in an HSM.
+ HsmClientCertificateIdentifier *string `type:"string"`
+
+ // The name of the HSM configuration that contains the information that the
+ // Amazon Redshift cluster can use to retrieve and store keys in an HSM.
+ HsmConfigurationIdentifier *string `type:"string"`
+
+ // Indicates whether the Amazon Redshift cluster has finished applying any HSM
+ // settings changes specified in a modify cluster command.
+ //
+ // Type: String
+ //
+ // Valid values: active | applying
+ Status *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterDetails) String() string {
+func (s AwsRedshiftClusterHsmStatus) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterDetails) GoString() string {
+func (s AwsRedshiftClusterHsmStatus) GoString() string {
return s.String()
}
-// SetAllowVersionUpgrade sets the AllowVersionUpgrade field's value.
-func (s *AwsRedshiftClusterDetails) SetAllowVersionUpgrade(v bool) *AwsRedshiftClusterDetails {
- s.AllowVersionUpgrade = &v
+// SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.
+func (s *AwsRedshiftClusterHsmStatus) SetHsmClientCertificateIdentifier(v string) *AwsRedshiftClusterHsmStatus {
+ s.HsmClientCertificateIdentifier = &v
return s
}
-// SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.
-func (s *AwsRedshiftClusterDetails) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails {
- s.AutomatedSnapshotRetentionPeriod = &v
+// SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.
+func (s *AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier(v string) *AwsRedshiftClusterHsmStatus {
+ s.HsmConfigurationIdentifier = &v
return s
}
-// SetAvailabilityZone sets the AvailabilityZone field's value.
-func (s *AwsRedshiftClusterDetails) SetAvailabilityZone(v string) *AwsRedshiftClusterDetails {
- s.AvailabilityZone = &v
+// SetStatus sets the Status field's value.
+func (s *AwsRedshiftClusterHsmStatus) SetStatus(v string) *AwsRedshiftClusterHsmStatus {
+ s.Status = &v
return s
}
-// SetClusterAvailabilityStatus sets the ClusterAvailabilityStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterAvailabilityStatus(v string) *AwsRedshiftClusterDetails {
- s.ClusterAvailabilityStatus = &v
- return s
+// An IAM role that the cluster can use to access other AWS services.
+type AwsRedshiftClusterIamRole struct {
+ _ struct{} `type:"structure"`
+
+ // The status of the IAM role's association with the cluster.
+ //
+ // Valid values: in-sync | adding | removing
+ ApplyStatus *string `type:"string"`
+
+ // The ARN of the IAM role.
+ IamRoleArn *string `type:"string"`
}
-// SetClusterCreateTime sets the ClusterCreateTime field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterCreateTime(v string) *AwsRedshiftClusterDetails {
- s.ClusterCreateTime = &v
- return s
+// String returns the string representation
+func (s AwsRedshiftClusterIamRole) String() string {
+ return awsutil.Prettify(s)
}
-// SetClusterIdentifier sets the ClusterIdentifier field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterIdentifier(v string) *AwsRedshiftClusterDetails {
- s.ClusterIdentifier = &v
- return s
+// GoString returns the string representation
+func (s AwsRedshiftClusterIamRole) GoString() string {
+ return s.String()
}
-// SetClusterNodes sets the ClusterNodes field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterNodes(v []*AwsRedshiftClusterClusterNode) *AwsRedshiftClusterDetails {
- s.ClusterNodes = v
+// SetApplyStatus sets the ApplyStatus field's value.
+func (s *AwsRedshiftClusterIamRole) SetApplyStatus(v string) *AwsRedshiftClusterIamRole {
+ s.ApplyStatus = &v
return s
}
-// SetClusterParameterGroups sets the ClusterParameterGroups field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterParameterGroups(v []*AwsRedshiftClusterClusterParameterGroup) *AwsRedshiftClusterDetails {
- s.ClusterParameterGroups = v
+// SetIamRoleArn sets the IamRoleArn field's value.
+func (s *AwsRedshiftClusterIamRole) SetIamRoleArn(v string) *AwsRedshiftClusterIamRole {
+ s.IamRoleArn = &v
return s
}
-// SetClusterPublicKey sets the ClusterPublicKey field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterPublicKey(v string) *AwsRedshiftClusterDetails {
- s.ClusterPublicKey = &v
- return s
+// Changes to the Amazon Redshift cluster that are currently pending.
+type AwsRedshiftClusterPendingModifiedValues struct {
+ _ struct{} `type:"structure"`
+
+ // The pending or in-progress change to the automated snapshot retention period.
+ AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`
+
+ // The pending or in-progress change to the identifier for the cluster.
+ ClusterIdentifier *string `type:"string"`
+
+ // The pending or in-progress change to the cluster type.
+ ClusterType *string `type:"string"`
+
+ // The pending or in-progress change to the service version.
+ ClusterVersion *string `type:"string"`
+
+ // The encryption type for a cluster.
+ EncryptionType *string `type:"string"`
+
+ // Indicates whether to create the cluster with enhanced VPC routing enabled.
+ EnhancedVpcRouting *bool `type:"boolean"`
+
+ // The name of the maintenance track that the cluster changes to during the
+ // next maintenance window.
+ MaintenanceTrackName *string `type:"string"`
+
+ // The pending or in-progress change to the master user password for the cluster.
+ MasterUserPassword *string `type:"string"`
+
+ // The pending or in-progress change to the cluster's node type.
+ NodeType *string `type:"string"`
+
+ // The pending or in-progress change to the number of nodes in the cluster.
+ NumberOfNodes *int64 `type:"integer"`
+
+ // The pending or in-progress change to whether the cluster can be connected
+ // to from the public network.
+ PubliclyAccessible *bool `type:"boolean"`
}
-// SetClusterRevisionNumber sets the ClusterRevisionNumber field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterRevisionNumber(v string) *AwsRedshiftClusterDetails {
- s.ClusterRevisionNumber = &v
- return s
+// String returns the string representation
+func (s AwsRedshiftClusterPendingModifiedValues) String() string {
+ return awsutil.Prettify(s)
}
-// SetClusterSecurityGroups sets the ClusterSecurityGroups field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterSecurityGroups(v []*AwsRedshiftClusterClusterSecurityGroup) *AwsRedshiftClusterDetails {
- s.ClusterSecurityGroups = v
- return s
+// GoString returns the string representation
+func (s AwsRedshiftClusterPendingModifiedValues) GoString() string {
+ return s.String()
}
-// SetClusterSnapshotCopyStatus sets the ClusterSnapshotCopyStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterSnapshotCopyStatus(v *AwsRedshiftClusterClusterSnapshotCopyStatus) *AwsRedshiftClusterDetails {
- s.ClusterSnapshotCopyStatus = v
+// SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterPendingModifiedValues {
+ s.AutomatedSnapshotRetentionPeriod = &v
return s
}
-// SetClusterStatus sets the ClusterStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterStatus(v string) *AwsRedshiftClusterDetails {
- s.ClusterStatus = &v
+// SetClusterIdentifier sets the ClusterIdentifier field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterIdentifier(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.ClusterIdentifier = &v
return s
}
-// SetClusterSubnetGroupName sets the ClusterSubnetGroupName field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterSubnetGroupName(v string) *AwsRedshiftClusterDetails {
- s.ClusterSubnetGroupName = &v
+// SetClusterType sets the ClusterType field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterType(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.ClusterType = &v
return s
}
// SetClusterVersion sets the ClusterVersion field's value.
-func (s *AwsRedshiftClusterDetails) SetClusterVersion(v string) *AwsRedshiftClusterDetails {
+func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterVersion(v string) *AwsRedshiftClusterPendingModifiedValues {
s.ClusterVersion = &v
return s
}
-// SetDBName sets the DBName field's value.
-func (s *AwsRedshiftClusterDetails) SetDBName(v string) *AwsRedshiftClusterDetails {
- s.DBName = &v
+// SetEncryptionType sets the EncryptionType field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetEncryptionType(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.EncryptionType = &v
return s
}
-// SetDeferredMaintenanceWindows sets the DeferredMaintenanceWindows field's value.
-func (s *AwsRedshiftClusterDetails) SetDeferredMaintenanceWindows(v []*AwsRedshiftClusterDeferredMaintenanceWindow) *AwsRedshiftClusterDetails {
- s.DeferredMaintenanceWindows = v
+// SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterPendingModifiedValues {
+ s.EnhancedVpcRouting = &v
return s
}
-// SetElasticIpStatus sets the ElasticIpStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetElasticIpStatus(v *AwsRedshiftClusterElasticIpStatus) *AwsRedshiftClusterDetails {
- s.ElasticIpStatus = v
+// SetMaintenanceTrackName sets the MaintenanceTrackName field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetMaintenanceTrackName(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.MaintenanceTrackName = &v
return s
}
-// SetElasticResizeNumberOfNodeOptions sets the ElasticResizeNumberOfNodeOptions field's value.
-func (s *AwsRedshiftClusterDetails) SetElasticResizeNumberOfNodeOptions(v string) *AwsRedshiftClusterDetails {
- s.ElasticResizeNumberOfNodeOptions = &v
+// SetMasterUserPassword sets the MasterUserPassword field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetMasterUserPassword(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.MasterUserPassword = &v
return s
}
-// SetEncrypted sets the Encrypted field's value.
-func (s *AwsRedshiftClusterDetails) SetEncrypted(v bool) *AwsRedshiftClusterDetails {
- s.Encrypted = &v
+// SetNodeType sets the NodeType field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetNodeType(v string) *AwsRedshiftClusterPendingModifiedValues {
+ s.NodeType = &v
return s
}
-// SetEndpoint sets the Endpoint field's value.
-func (s *AwsRedshiftClusterDetails) SetEndpoint(v *AwsRedshiftClusterEndpoint) *AwsRedshiftClusterDetails {
- s.Endpoint = v
+// SetNumberOfNodes sets the NumberOfNodes field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetNumberOfNodes(v int64) *AwsRedshiftClusterPendingModifiedValues {
+ s.NumberOfNodes = &v
return s
}
-// SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.
-func (s *AwsRedshiftClusterDetails) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterDetails {
- s.EnhancedVpcRouting = &v
+// SetPubliclyAccessible sets the PubliclyAccessible field's value.
+func (s *AwsRedshiftClusterPendingModifiedValues) SetPubliclyAccessible(v bool) *AwsRedshiftClusterPendingModifiedValues {
+ s.PubliclyAccessible = &v
return s
}
-// SetExpectedNextSnapshotScheduleTime sets the ExpectedNextSnapshotScheduleTime field's value.
-func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTime(v string) *AwsRedshiftClusterDetails {
- s.ExpectedNextSnapshotScheduleTime = &v
- return s
-}
+// Information about the resize operation for the cluster.
+type AwsRedshiftClusterResizeInfo struct {
+ _ struct{} `type:"structure"`
-// SetExpectedNextSnapshotScheduleTimeStatus sets the ExpectedNextSnapshotScheduleTimeStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetExpectedNextSnapshotScheduleTimeStatus(v string) *AwsRedshiftClusterDetails {
- s.ExpectedNextSnapshotScheduleTimeStatus = &v
- return s
-}
+ // Indicates whether the resize operation can be canceled.
+ AllowCancelResize *bool `type:"boolean"`
-// SetHsmStatus sets the HsmStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetHsmStatus(v *AwsRedshiftClusterHsmStatus) *AwsRedshiftClusterDetails {
- s.HsmStatus = v
- return s
+ // The type of resize operation.
+ //
+ // Valid values: ClassicResize
+ ResizeType *string `type:"string"`
}
-// SetIamRoles sets the IamRoles field's value.
-func (s *AwsRedshiftClusterDetails) SetIamRoles(v []*AwsRedshiftClusterIamRole) *AwsRedshiftClusterDetails {
- s.IamRoles = v
- return s
+// String returns the string representation
+func (s AwsRedshiftClusterResizeInfo) String() string {
+ return awsutil.Prettify(s)
}
-// SetKmsKeyId sets the KmsKeyId field's value.
-func (s *AwsRedshiftClusterDetails) SetKmsKeyId(v string) *AwsRedshiftClusterDetails {
- s.KmsKeyId = &v
- return s
+// GoString returns the string representation
+func (s AwsRedshiftClusterResizeInfo) GoString() string {
+ return s.String()
}
-// SetMaintenanceTrackName sets the MaintenanceTrackName field's value.
-func (s *AwsRedshiftClusterDetails) SetMaintenanceTrackName(v string) *AwsRedshiftClusterDetails {
- s.MaintenanceTrackName = &v
+// SetAllowCancelResize sets the AllowCancelResize field's value.
+func (s *AwsRedshiftClusterResizeInfo) SetAllowCancelResize(v bool) *AwsRedshiftClusterResizeInfo {
+ s.AllowCancelResize = &v
return s
}
-// SetManualSnapshotRetentionPeriod sets the ManualSnapshotRetentionPeriod field's value.
-func (s *AwsRedshiftClusterDetails) SetManualSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterDetails {
- s.ManualSnapshotRetentionPeriod = &v
+// SetResizeType sets the ResizeType field's value.
+func (s *AwsRedshiftClusterResizeInfo) SetResizeType(v string) *AwsRedshiftClusterResizeInfo {
+ s.ResizeType = &v
return s
}
-// SetMasterUsername sets the MasterUsername field's value.
-func (s *AwsRedshiftClusterDetails) SetMasterUsername(v string) *AwsRedshiftClusterDetails {
- s.MasterUsername = &v
- return s
-}
+// Information about the status of a cluster restore action. It only applies
+// if the cluster was created by restoring a snapshot.
+type AwsRedshiftClusterRestoreStatus struct {
+ _ struct{} `type:"structure"`
-// SetNextMaintenanceWindowStartTime sets the NextMaintenanceWindowStartTime field's value.
-func (s *AwsRedshiftClusterDetails) SetNextMaintenanceWindowStartTime(v string) *AwsRedshiftClusterDetails {
- s.NextMaintenanceWindowStartTime = &v
- return s
-}
+ // The number of megabytes per second being transferred from the backup storage.
+ // Returns the average rate for a completed backup.
+ //
+ // This field is only updated when you restore to DC2 and DS2 node types.
+ CurrentRestoreRateInMegaBytesPerSecond *float64 `type:"double"`
-// SetNodeType sets the NodeType field's value.
-func (s *AwsRedshiftClusterDetails) SetNodeType(v string) *AwsRedshiftClusterDetails {
- s.NodeType = &v
- return s
-}
+ // The amount of time an in-progress restore has been running, or the amount
+ // of time it took a completed restore to finish.
+ //
+ // This field is only updated when you restore to DC2 and DS2 node types.
+ ElapsedTimeInSeconds *int64 `type:"long"`
-// SetNumberOfNodes sets the NumberOfNodes field's value.
-func (s *AwsRedshiftClusterDetails) SetNumberOfNodes(v int64) *AwsRedshiftClusterDetails {
- s.NumberOfNodes = &v
- return s
-}
+ // The estimate of the time remaining before the restore is complete. Returns
+ // 0 for a completed restore.
+ //
+ // This field is only updated when you restore to DC2 and DS2 node types.
+ EstimatedTimeToCompletionInSeconds *int64 `type:"long"`
-// SetPendingActions sets the PendingActions field's value.
-func (s *AwsRedshiftClusterDetails) SetPendingActions(v []*string) *AwsRedshiftClusterDetails {
- s.PendingActions = v
- return s
-}
+ // The number of megabytes that were transferred from snapshot storage.
+ //
+ // This field is only updated when you restore to DC2 and DS2 node types.
+ ProgressInMegaBytes *int64 `type:"long"`
-// SetPendingModifiedValues sets the PendingModifiedValues field's value.
-func (s *AwsRedshiftClusterDetails) SetPendingModifiedValues(v *AwsRedshiftClusterPendingModifiedValues) *AwsRedshiftClusterDetails {
- s.PendingModifiedValues = v
- return s
+ // The size of the set of snapshot data that was used to restore the cluster.
+ //
+ // This field is only updated when you restore to DC2 and DS2 node types.
+ SnapshotSizeInMegaBytes *int64 `type:"long"`
+
+ // The status of the restore action.
+ //
+ // Valid values: starting | restoring | completed | failed
+ Status *string `type:"string"`
}
-// SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.
-func (s *AwsRedshiftClusterDetails) SetPreferredMaintenanceWindow(v string) *AwsRedshiftClusterDetails {
- s.PreferredMaintenanceWindow = &v
- return s
+// String returns the string representation
+func (s AwsRedshiftClusterRestoreStatus) String() string {
+ return awsutil.Prettify(s)
}
-// SetPubliclyAccessible sets the PubliclyAccessible field's value.
-func (s *AwsRedshiftClusterDetails) SetPubliclyAccessible(v bool) *AwsRedshiftClusterDetails {
- s.PubliclyAccessible = &v
- return s
+// GoString returns the string representation
+func (s AwsRedshiftClusterRestoreStatus) GoString() string {
+ return s.String()
}
-// SetResizeInfo sets the ResizeInfo field's value.
-func (s *AwsRedshiftClusterDetails) SetResizeInfo(v *AwsRedshiftClusterResizeInfo) *AwsRedshiftClusterDetails {
- s.ResizeInfo = v
+// SetCurrentRestoreRateInMegaBytesPerSecond sets the CurrentRestoreRateInMegaBytesPerSecond field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetCurrentRestoreRateInMegaBytesPerSecond(v float64) *AwsRedshiftClusterRestoreStatus {
+ s.CurrentRestoreRateInMegaBytesPerSecond = &v
return s
}
-// SetRestoreStatus sets the RestoreStatus field's value.
-func (s *AwsRedshiftClusterDetails) SetRestoreStatus(v *AwsRedshiftClusterRestoreStatus) *AwsRedshiftClusterDetails {
- s.RestoreStatus = v
+// SetElapsedTimeInSeconds sets the ElapsedTimeInSeconds field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetElapsedTimeInSeconds(v int64) *AwsRedshiftClusterRestoreStatus {
+ s.ElapsedTimeInSeconds = &v
return s
}
-// SetSnapshotScheduleIdentifier sets the SnapshotScheduleIdentifier field's value.
-func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleIdentifier(v string) *AwsRedshiftClusterDetails {
- s.SnapshotScheduleIdentifier = &v
+// SetEstimatedTimeToCompletionInSeconds sets the EstimatedTimeToCompletionInSeconds field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds(v int64) *AwsRedshiftClusterRestoreStatus {
+ s.EstimatedTimeToCompletionInSeconds = &v
return s
}
-// SetSnapshotScheduleState sets the SnapshotScheduleState field's value.
-func (s *AwsRedshiftClusterDetails) SetSnapshotScheduleState(v string) *AwsRedshiftClusterDetails {
- s.SnapshotScheduleState = &v
+// SetProgressInMegaBytes sets the ProgressInMegaBytes field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetProgressInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus {
+ s.ProgressInMegaBytes = &v
return s
}
-// SetVpcId sets the VpcId field's value.
-func (s *AwsRedshiftClusterDetails) SetVpcId(v string) *AwsRedshiftClusterDetails {
- s.VpcId = &v
+// SetSnapshotSizeInMegaBytes sets the SnapshotSizeInMegaBytes field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus {
+ s.SnapshotSizeInMegaBytes = &v
return s
}
-// SetVpcSecurityGroups sets the VpcSecurityGroups field's value.
-func (s *AwsRedshiftClusterDetails) SetVpcSecurityGroups(v []*AwsRedshiftClusterVpcSecurityGroup) *AwsRedshiftClusterDetails {
- s.VpcSecurityGroups = v
+// SetStatus sets the Status field's value.
+func (s *AwsRedshiftClusterRestoreStatus) SetStatus(v string) *AwsRedshiftClusterRestoreStatus {
+ s.Status = &v
return s
}
-// The status of the elastic IP (EIP) address for an Amazon Redshift cluster.
-type AwsRedshiftClusterElasticIpStatus struct {
+// A VPC security group that the cluster belongs to, if the cluster is in a
+// VPC.
+type AwsRedshiftClusterVpcSecurityGroup struct {
_ struct{} `type:"structure"`
- // The elastic IP address for the cluster.
- ElasticIp *string `type:"string"`
-
- // The status of the elastic IP address.
+ // The status of the VPC security group.
Status *string `type:"string"`
+
+ // The identifier of the VPC security group.
+ VpcSecurityGroupId *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterElasticIpStatus) String() string {
+func (s AwsRedshiftClusterVpcSecurityGroup) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterElasticIpStatus) GoString() string {
+func (s AwsRedshiftClusterVpcSecurityGroup) GoString() string {
return s.String()
}
-// SetElasticIp sets the ElasticIp field's value.
-func (s *AwsRedshiftClusterElasticIpStatus) SetElasticIp(v string) *AwsRedshiftClusterElasticIpStatus {
- s.ElasticIp = &v
+// SetStatus sets the Status field's value.
+func (s *AwsRedshiftClusterVpcSecurityGroup) SetStatus(v string) *AwsRedshiftClusterVpcSecurityGroup {
+ s.Status = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRedshiftClusterElasticIpStatus) SetStatus(v string) *AwsRedshiftClusterElasticIpStatus {
- s.Status = &v
+// SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.
+func (s *AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRedshiftClusterVpcSecurityGroup {
+ s.VpcSecurityGroupId = &v
return s
}
-// The connection endpoint for an Amazon Redshift cluster.
-type AwsRedshiftClusterEndpoint struct {
+// provides information about the Amazon S3 Public Access Block configuration
+// for accounts.
+type AwsS3AccountPublicAccessBlockDetails struct {
_ struct{} `type:"structure"`
- // The DNS address of the cluster.
- Address *string `type:"string"`
+ // Indicates whether to reject calls to update an S3 bucket if the calls include
+ // a public access control list (ACL).
+ BlockPublicAcls *bool `type:"boolean"`
- // The port that the database engine listens on.
- Port *int64 `type:"integer"`
+ // Indicates whether to reject calls to update the access policy for an S3 bucket
+ // or access point if the policy allows public access.
+ BlockPublicPolicy *bool `type:"boolean"`
+
+ // Indicates whether Amazon S3 ignores public ACLs that are associated with
+ // an S3 bucket.
+ IgnorePublicAcls *bool `type:"boolean"`
+
+ // Indicates whether to restrict access to an access point or S3 bucket that
+ // has a public policy to only AWS service principals and authorized users within
+ // the S3 bucket owner's account.
+ RestrictPublicBuckets *bool `type:"boolean"`
}
// String returns the string representation
-func (s AwsRedshiftClusterEndpoint) String() string {
+func (s AwsS3AccountPublicAccessBlockDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterEndpoint) GoString() string {
+func (s AwsS3AccountPublicAccessBlockDetails) GoString() string {
return s.String()
}
-// SetAddress sets the Address field's value.
-func (s *AwsRedshiftClusterEndpoint) SetAddress(v string) *AwsRedshiftClusterEndpoint {
- s.Address = &v
+// SetBlockPublicAcls sets the BlockPublicAcls field's value.
+func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails {
+ s.BlockPublicAcls = &v
return s
}
-// SetPort sets the Port field's value.
-func (s *AwsRedshiftClusterEndpoint) SetPort(v int64) *AwsRedshiftClusterEndpoint {
- s.Port = &v
+// SetBlockPublicPolicy sets the BlockPublicPolicy field's value.
+func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicPolicy(v bool) *AwsS3AccountPublicAccessBlockDetails {
+ s.BlockPublicPolicy = &v
return s
}
-// Information about whether an Amazon Redshift cluster finished applying any
-// hardware changes to security module (HSM) settings that were specified in
-// a modify cluster command.
-type AwsRedshiftClusterHsmStatus struct {
- _ struct{} `type:"structure"`
+// SetIgnorePublicAcls sets the IgnorePublicAcls field's value.
+func (s *AwsS3AccountPublicAccessBlockDetails) SetIgnorePublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails {
+ s.IgnorePublicAcls = &v
+ return s
+}
- // The name of the HSM client certificate that the Amazon Redshift cluster uses
- // to retrieve the data encryption keys that are stored in an HSM.
- HsmClientCertificateIdentifier *string `type:"string"`
+// SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.
+func (s *AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets(v bool) *AwsS3AccountPublicAccessBlockDetails {
+ s.RestrictPublicBuckets = &v
+ return s
+}
- // The name of the HSM configuration that contains the information that the
- // Amazon Redshift cluster can use to retrieve and store keys in an HSM.
- HsmConfigurationIdentifier *string `type:"string"`
+// The lifecycle configuration for the objects in the S3 bucket.
+type AwsS3BucketBucketLifecycleConfigurationDetails struct {
+ _ struct{} `type:"structure"`
- // Indicates whether the Amazon Redshift cluster has finished applying any HSM
- // settings changes specified in a modify cluster command.
- //
- // Type: String
- //
- // Valid values: active | applying
- Status *string `type:"string"`
+ // The lifecycle rules.
+ Rules []*AwsS3BucketBucketLifecycleConfigurationRulesDetails `type:"list"`
}
// String returns the string representation
-func (s AwsRedshiftClusterHsmStatus) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterHsmStatus) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationDetails) GoString() string {
return s.String()
}
-// SetHsmClientCertificateIdentifier sets the HsmClientCertificateIdentifier field's value.
-func (s *AwsRedshiftClusterHsmStatus) SetHsmClientCertificateIdentifier(v string) *AwsRedshiftClusterHsmStatus {
- s.HsmClientCertificateIdentifier = &v
- return s
-}
-
-// SetHsmConfigurationIdentifier sets the HsmConfigurationIdentifier field's value.
-func (s *AwsRedshiftClusterHsmStatus) SetHsmConfigurationIdentifier(v string) *AwsRedshiftClusterHsmStatus {
- s.HsmConfigurationIdentifier = &v
- return s
-}
-
-// SetStatus sets the Status field's value.
-func (s *AwsRedshiftClusterHsmStatus) SetStatus(v string) *AwsRedshiftClusterHsmStatus {
- s.Status = &v
+// SetRules sets the Rules field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationDetails) SetRules(v []*AwsS3BucketBucketLifecycleConfigurationRulesDetails) *AwsS3BucketBucketLifecycleConfigurationDetails {
+ s.Rules = v
return s
}
-// An IAM role that the cluster can use to access other AWS services.
-type AwsRedshiftClusterIamRole struct {
+// Information about what Amazon S3 does when a multipart upload is incomplete.
+type AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails struct {
_ struct{} `type:"structure"`
- // The status of the IAM role's association with the cluster.
- //
- // Valid values: in-sync | adding | removing
- ApplyStatus *string `type:"string"`
-
- // The ARN of the IAM role.
- IamRoleArn *string `type:"string"`
+ // The number of days after which Amazon S3 cancels an incomplete multipart
+ // upload.
+ DaysAfterInitiation *int64 `type:"integer"`
}
// String returns the string representation
-func (s AwsRedshiftClusterIamRole) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterIamRole) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) GoString() string {
return s.String()
}
-// SetApplyStatus sets the ApplyStatus field's value.
-func (s *AwsRedshiftClusterIamRole) SetApplyStatus(v string) *AwsRedshiftClusterIamRole {
- s.ApplyStatus = &v
- return s
-}
-
-// SetIamRoleArn sets the IamRoleArn field's value.
-func (s *AwsRedshiftClusterIamRole) SetIamRoleArn(v string) *AwsRedshiftClusterIamRole {
- s.IamRoleArn = &v
+// SetDaysAfterInitiation sets the DaysAfterInitiation field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) SetDaysAfterInitiation(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails {
+ s.DaysAfterInitiation = &v
return s
}
-// Changes to the Amazon Redshift cluster that are currently pending.
-type AwsRedshiftClusterPendingModifiedValues struct {
+// Configuration for a lifecycle rule.
+type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct {
_ struct{} `type:"structure"`
- // The pending or in-progress change to the automated snapshot retention period.
- AutomatedSnapshotRetentionPeriod *int64 `type:"integer"`
-
- // The pending or in-progress change to the identifier for the cluster.
- ClusterIdentifier *string `type:"string"`
+ // How Amazon S3 responds when a multipart upload is incomplete. Specifically,
+ // provides a number of days before Amazon S3 cancels the entire upload.
+ AbortIncompleteMultipartUpload *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails `type:"structure"`
- // The pending or in-progress change to the cluster type.
- ClusterType *string `type:"string"`
+ // The date when objects are moved or deleted.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ ExpirationDate *string `type:"string"`
- // The pending or in-progress change to the service version.
- ClusterVersion *string `type:"string"`
+ // The length in days of the lifetime for objects that are subject to the rule.
+ ExpirationInDays *int64 `type:"integer"`
- // The encryption type for a cluster.
- EncryptionType *string `type:"string"`
+ // Whether Amazon S3 removes a delete marker that has no noncurrent versions.
+ // If set to true, the delete marker is expired. If set to false, the policy
+ // takes no action.
+ //
+ // If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays
+ // or ExpirationDate.
+ ExpiredObjectDeleteMarker *bool `type:"boolean"`
- // Indicates whether to create the cluster with enhanced VPC routing enabled.
- EnhancedVpcRouting *bool `type:"boolean"`
+ // Identifies the objects that a rule applies to.
+ Filter *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails `type:"structure"`
- // The name of the maintenance track that the cluster changes to during the
- // next maintenance window.
- MaintenanceTrackName *string `type:"string"`
+ // The unique identifier of the rule.
+ ID *string `type:"string"`
- // The pending or in-progress change to the master user password for the cluster.
- MasterUserPassword *string `type:"string"`
+ // The number of days that an object is noncurrent before Amazon S3 can perform
+ // the associated action.
+ NoncurrentVersionExpirationInDays *int64 `type:"integer"`
- // The pending or in-progress change to the cluster's node type.
- NodeType *string `type:"string"`
+ // Transition rules that describe when noncurrent objects transition to a specified
+ // storage class.
+ NoncurrentVersionTransitions []*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails `type:"list"`
- // The pending or in-progress change to the number of nodes in the cluster.
- NumberOfNodes *int64 `type:"integer"`
+ // A prefix that identifies one or more objects that the rule applies to.
+ Prefix *string `type:"string"`
- // The pending or in-progress change to whether the cluster can be connected
- // to from the public network.
- PubliclyAccessible *bool `type:"boolean"`
+ // The current status of the rule. Indicates whether the rule is currently being
+ // applied.
+ Status *string `type:"string"`
+
+ // Transition rules that indicate when objects transition to a specified storage
+ // class.
+ Transitions []*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails `type:"list"`
}
// String returns the string representation
-func (s AwsRedshiftClusterPendingModifiedValues) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterPendingModifiedValues) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesDetails) GoString() string {
return s.String()
}
-// SetAutomatedSnapshotRetentionPeriod sets the AutomatedSnapshotRetentionPeriod field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetAutomatedSnapshotRetentionPeriod(v int64) *AwsRedshiftClusterPendingModifiedValues {
- s.AutomatedSnapshotRetentionPeriod = &v
+// SetAbortIncompleteMultipartUpload sets the AbortIncompleteMultipartUpload field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetAbortIncompleteMultipartUpload(v *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.AbortIncompleteMultipartUpload = v
return s
}
-// SetClusterIdentifier sets the ClusterIdentifier field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterIdentifier(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.ClusterIdentifier = &v
+// SetExpirationDate sets the ExpirationDate field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationDate(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.ExpirationDate = &v
return s
}
-// SetClusterType sets the ClusterType field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterType(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.ClusterType = &v
+// SetExpirationInDays sets the ExpirationInDays field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpirationInDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.ExpirationInDays = &v
return s
}
-// SetClusterVersion sets the ClusterVersion field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetClusterVersion(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.ClusterVersion = &v
+// SetExpiredObjectDeleteMarker sets the ExpiredObjectDeleteMarker field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetExpiredObjectDeleteMarker(v bool) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.ExpiredObjectDeleteMarker = &v
return s
}
-// SetEncryptionType sets the EncryptionType field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetEncryptionType(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.EncryptionType = &v
+// SetFilter sets the Filter field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetFilter(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.Filter = v
return s
}
-// SetEnhancedVpcRouting sets the EnhancedVpcRouting field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetEnhancedVpcRouting(v bool) *AwsRedshiftClusterPendingModifiedValues {
- s.EnhancedVpcRouting = &v
+// SetID sets the ID field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetID(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.ID = &v
return s
}
-// SetMaintenanceTrackName sets the MaintenanceTrackName field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetMaintenanceTrackName(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.MaintenanceTrackName = &v
+// SetNoncurrentVersionExpirationInDays sets the NoncurrentVersionExpirationInDays field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionExpirationInDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.NoncurrentVersionExpirationInDays = &v
return s
}
-// SetMasterUserPassword sets the MasterUserPassword field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetMasterUserPassword(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.MasterUserPassword = &v
+// SetNoncurrentVersionTransitions sets the NoncurrentVersionTransitions field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetNoncurrentVersionTransitions(v []*AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.NoncurrentVersionTransitions = v
return s
}
-// SetNodeType sets the NodeType field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetNodeType(v string) *AwsRedshiftClusterPendingModifiedValues {
- s.NodeType = &v
+// SetPrefix sets the Prefix field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.Prefix = &v
return s
}
-// SetNumberOfNodes sets the NumberOfNodes field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetNumberOfNodes(v int64) *AwsRedshiftClusterPendingModifiedValues {
- s.NumberOfNodes = &v
+// SetStatus sets the Status field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetStatus(v string) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.Status = &v
return s
}
-// SetPubliclyAccessible sets the PubliclyAccessible field's value.
-func (s *AwsRedshiftClusterPendingModifiedValues) SetPubliclyAccessible(v bool) *AwsRedshiftClusterPendingModifiedValues {
- s.PubliclyAccessible = &v
+// SetTransitions sets the Transitions field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesDetails) SetTransitions(v []*AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesDetails {
+ s.Transitions = v
return s
}
-// Information about the resize operation for the cluster.
-type AwsRedshiftClusterResizeInfo struct {
+// Identifies the objects that a rule applies to.
+type AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails struct {
_ struct{} `type:"structure"`
- // Indicates whether the resize operation can be canceled.
- AllowCancelResize *bool `type:"boolean"`
-
- // The type of resize operation.
- //
- // Valid values: ClassicResize
- ResizeType *string `type:"string"`
+ // The configuration for the filter.
+ Predicate *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails `type:"structure"`
}
// String returns the string representation
-func (s AwsRedshiftClusterResizeInfo) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterResizeInfo) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) GoString() string {
return s.String()
}
-// SetAllowCancelResize sets the AllowCancelResize field's value.
-func (s *AwsRedshiftClusterResizeInfo) SetAllowCancelResize(v bool) *AwsRedshiftClusterResizeInfo {
- s.AllowCancelResize = &v
+// SetPredicate sets the Predicate field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails) SetPredicate(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails {
+ s.Predicate = v
return s
}
-// SetResizeType sets the ResizeType field's value.
-func (s *AwsRedshiftClusterResizeInfo) SetResizeType(v string) *AwsRedshiftClusterResizeInfo {
- s.ResizeType = &v
+// The configuration for the filter.
+type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The values to use for the filter.
+ Operands []*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails `type:"list"`
+
+ // A prefix filter.
+ Prefix *string `type:"string"`
+
+ // A tag filter.
+ Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails `type:"structure"`
+
+ // Whether to use AND or OR to join the operands.
+ Type *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) GoString() string {
+ return s.String()
+}
+
+// SetOperands sets the Operands field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetOperands(v []*AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails {
+ s.Operands = v
return s
}
-// Information about the status of a cluster restore action. It only applies
-// if the cluster was created by restoring a snapshot.
-type AwsRedshiftClusterRestoreStatus struct {
- _ struct{} `type:"structure"`
+// SetPrefix sets the Prefix field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails {
+ s.Prefix = &v
+ return s
+}
- // The number of megabytes per second being transferred from the backup storage.
- // Returns the average rate for a completed backup.
- //
- // This field is only updated when you restore to DC2 and DS2 node types.
- CurrentRestoreRateInMegaBytesPerSecond *float64 `type:"double"`
+// SetTag sets the Tag field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetTag(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails {
+ s.Tag = v
+ return s
+}
- // The amount of time an in-progress restore has been running, or the amount
- // of time it took a completed restore to finish.
- //
- // This field is only updated when you restore to DC2 and DS2 node types.
- ElapsedTimeInSeconds *int64 `type:"long"`
+// SetType sets the Type field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails) SetType(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails {
+ s.Type = &v
+ return s
+}
- // The estimate of the time remaining before the restore is complete. Returns
- // 0 for a completed restore.
- //
- // This field is only updated when you restore to DC2 and DS2 node types.
- EstimatedTimeToCompletionInSeconds *int64 `type:"long"`
+// A value to use for the filter.
+type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails struct {
+ _ struct{} `type:"structure"`
- // The number of megabytes that were transferred from snapshot storage.
- //
- // This field is only updated when you restore to DC2 and DS2 node types.
- ProgressInMegaBytes *int64 `type:"long"`
+ // Prefix text for matching objects.
+ Prefix *string `type:"string"`
- // The size of the set of snapshot data that was used to restore the cluster.
- //
- // This field is only updated when you restore to DC2 and DS2 node types.
- SnapshotSizeInMegaBytes *int64 `type:"long"`
+ // A tag that is assigned to matching objects.
+ Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails `type:"structure"`
- // The status of the restore action.
- //
- // Valid values: starting | restoring | completed | failed
- Status *string `type:"string"`
+ // The type of filter value.
+ Type *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterRestoreStatus) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterRestoreStatus) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) GoString() string {
return s.String()
}
-// SetCurrentRestoreRateInMegaBytesPerSecond sets the CurrentRestoreRateInMegaBytesPerSecond field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetCurrentRestoreRateInMegaBytesPerSecond(v float64) *AwsRedshiftClusterRestoreStatus {
- s.CurrentRestoreRateInMegaBytesPerSecond = &v
+// SetPrefix sets the Prefix field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetPrefix(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails {
+ s.Prefix = &v
return s
}
-// SetElapsedTimeInSeconds sets the ElapsedTimeInSeconds field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetElapsedTimeInSeconds(v int64) *AwsRedshiftClusterRestoreStatus {
- s.ElapsedTimeInSeconds = &v
+// SetTag sets the Tag field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetTag(v *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails {
+ s.Tag = v
return s
}
-// SetEstimatedTimeToCompletionInSeconds sets the EstimatedTimeToCompletionInSeconds field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetEstimatedTimeToCompletionInSeconds(v int64) *AwsRedshiftClusterRestoreStatus {
- s.EstimatedTimeToCompletionInSeconds = &v
+// SetType sets the Type field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails) SetType(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails {
+ s.Type = &v
return s
}
-// SetProgressInMegaBytes sets the ProgressInMegaBytes field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetProgressInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus {
- s.ProgressInMegaBytes = &v
- return s
+// A tag that is assigned to matching objects.
+type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails struct {
+ _ struct{} `type:"structure"`
+
+ // The tag key.
+ Key *string `type:"string"`
+
+ // The tag value.
+ Value *string `type:"string"`
}
-// SetSnapshotSizeInMegaBytes sets the SnapshotSizeInMegaBytes field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetSnapshotSizeInMegaBytes(v int64) *AwsRedshiftClusterRestoreStatus {
- s.SnapshotSizeInMegaBytes = &v
+// String returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) GoString() string {
+ return s.String()
+}
+
+// SetKey sets the Key field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetKey(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails {
+ s.Key = &v
return s
}
-// SetStatus sets the Status field's value.
-func (s *AwsRedshiftClusterRestoreStatus) SetStatus(v string) *AwsRedshiftClusterRestoreStatus {
- s.Status = &v
+// SetValue sets the Value field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails) SetValue(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails {
+ s.Value = &v
return s
}
-// A VPC security group that the cluster belongs to, if the cluster is in a
-// VPC.
-type AwsRedshiftClusterVpcSecurityGroup struct {
+// A tag filter.
+type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails struct {
_ struct{} `type:"structure"`
- // The status of the VPC security group.
- Status *string `type:"string"`
+ // The tag key.
+ Key *string `type:"string"`
- // The identifier of the VPC security group.
- VpcSecurityGroupId *string `type:"string"`
+ // The tag value
+ Value *string `type:"string"`
}
// String returns the string representation
-func (s AwsRedshiftClusterVpcSecurityGroup) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsRedshiftClusterVpcSecurityGroup) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) GoString() string {
return s.String()
}
-// SetStatus sets the Status field's value.
-func (s *AwsRedshiftClusterVpcSecurityGroup) SetStatus(v string) *AwsRedshiftClusterVpcSecurityGroup {
- s.Status = &v
+// SetKey sets the Key field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetKey(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails {
+ s.Key = &v
return s
}
-// SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.
-func (s *AwsRedshiftClusterVpcSecurityGroup) SetVpcSecurityGroupId(v string) *AwsRedshiftClusterVpcSecurityGroup {
- s.VpcSecurityGroupId = &v
+// SetValue sets the Value field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails) SetValue(v string) *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails {
+ s.Value = &v
return s
}
-// provides information about the Amazon S3 Public Access Block configuration
-// for accounts.
-type AwsS3AccountPublicAccessBlockDetails struct {
+// A transition rule that describes when noncurrent objects transition to a
+// specified storage class.
+type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails struct {
_ struct{} `type:"structure"`
- // Indicates whether to reject calls to update an S3 bucket if the calls include
- // a public access control list (ACL).
- BlockPublicAcls *bool `type:"boolean"`
-
- // Indicates whether to reject calls to update the access policy for an S3 bucket
- // or access point if the policy allows public access.
- BlockPublicPolicy *bool `type:"boolean"`
-
- // Indicates whether Amazon S3 ignores public ACLs that are associated with
- // an S3 bucket.
- IgnorePublicAcls *bool `type:"boolean"`
+ // The number of days that an object is noncurrent before Amazon S3 can perform
+ // the associated action.
+ Days *int64 `type:"integer"`
- // Indicates whether to restrict access to an access point or S3 bucket that
- // has a public policy to only AWS service principals and authorized users within
- // the S3 bucket owner's account.
- RestrictPublicBuckets *bool `type:"boolean"`
+ // The class of storage to change the object to after the object is noncurrent
+ // for the specified number of days.
+ StorageClass *string `type:"string"`
}
// String returns the string representation
-func (s AwsS3AccountPublicAccessBlockDetails) String() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
-func (s AwsS3AccountPublicAccessBlockDetails) GoString() string {
+func (s AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) GoString() string {
return s.String()
}
-// SetBlockPublicAcls sets the BlockPublicAcls field's value.
-func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails {
- s.BlockPublicAcls = &v
+// SetDays sets the Days field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails {
+ s.Days = &v
return s
}
-// SetBlockPublicPolicy sets the BlockPublicPolicy field's value.
-func (s *AwsS3AccountPublicAccessBlockDetails) SetBlockPublicPolicy(v bool) *AwsS3AccountPublicAccessBlockDetails {
- s.BlockPublicPolicy = &v
+// SetStorageClass sets the StorageClass field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails) SetStorageClass(v string) *AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails {
+ s.StorageClass = &v
return s
}
-// SetIgnorePublicAcls sets the IgnorePublicAcls field's value.
-func (s *AwsS3AccountPublicAccessBlockDetails) SetIgnorePublicAcls(v bool) *AwsS3AccountPublicAccessBlockDetails {
- s.IgnorePublicAcls = &v
+// A rule for when objects transition to specific storage classes.
+type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct {
+ _ struct{} `type:"structure"`
+
+ // A date on which to transition objects to the specified storage class. If
+ // you provide Date, you cannot provide Days.
+ //
+ // Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
+ // Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot
+ // contain spaces. For example, 2020-03-22T13:22:13.933Z.
+ Date *string `type:"string"`
+
+ // The number of days after which to transition the object to the specified
+ // storage class. If you provide Days, you cannot provide Date.
+ Days *int64 `type:"integer"`
+
+ // The storage class to transition the object to.
+ StorageClass *string `type:"string"`
+}
+
+// String returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) GoString() string {
+ return s.String()
+}
+
+// SetDate sets the Date field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDate(v string) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails {
+ s.Date = &v
return s
}
-// SetRestrictPublicBuckets sets the RestrictPublicBuckets field's value.
-func (s *AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets(v bool) *AwsS3AccountPublicAccessBlockDetails {
- s.RestrictPublicBuckets = &v
+// SetDays sets the Days field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetDays(v int64) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails {
+ s.Days = &v
+ return s
+}
+
+// SetStorageClass sets the StorageClass field's value.
+func (s *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails) SetStorageClass(v string) *AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails {
+ s.StorageClass = &v
return s
}
@@ -17552,6 +20199,9 @@ func (s *AwsS3AccountPublicAccessBlockDetails) SetRestrictPublicBuckets(v bool)
type AwsS3BucketDetails struct {
_ struct{} `type:"structure"`
+ // The lifecycle configuration for objects in the S3 bucket.
+ BucketLifecycleConfiguration *AwsS3BucketBucketLifecycleConfigurationDetails `type:"structure"`
+
// Indicates when the S3 bucket was created.
//
// Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
@@ -17583,6 +20233,12 @@ func (s AwsS3BucketDetails) GoString() string {
return s.String()
}
+// SetBucketLifecycleConfiguration sets the BucketLifecycleConfiguration field's value.
+func (s *AwsS3BucketDetails) SetBucketLifecycleConfiguration(v *AwsS3BucketBucketLifecycleConfigurationDetails) *AwsS3BucketDetails {
+ s.BucketLifecycleConfiguration = v
+ return s
+}
+
// SetCreatedAt sets the CreatedAt field's value.
func (s *AwsS3BucketDetails) SetCreatedAt(v string) *AwsS3BucketDetails {
s.CreatedAt = &v
@@ -18488,7 +21144,9 @@ type AwsSecurityFindingFilters struct {
Id []*StringFilter `type:"list"`
// A keyword for a finding.
- Keyword []*KeywordFilter `type:"list"`
+ //
+ // Deprecated: The Keyword property is deprecated.
+ Keyword []*KeywordFilter `deprecated:"true" type:"list"`
// An ISO8601-formatted timestamp that indicates when the security-findings
// provider most recently observed the potential security issue that a finding
@@ -19357,7 +22015,7 @@ func (s *AwsSecurityFindingIdentifier) SetProductArn(v string) *AwsSecurityFindi
return s
}
-// A wrapper type for the topic's Amazon Resource Name (ARN).
+// A wrapper type for the topic's ARN.
type AwsSnsTopicDetails struct {
_ struct{} `type:"structure"`
@@ -19447,8 +22105,8 @@ func (s *AwsSnsTopicSubscription) SetProtocol(v string) *AwsSnsTopicSubscription
type AwsSqsQueueDetails struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
- // moves messages after the value of maxReceiveCount is exceeded.
+ // The ARN of the dead-letter queue to which Amazon SQS moves messages after
+ // the value of maxReceiveCount is exceeded.
DeadLetterTargetArn *string `type:"string"`
// The length of time, in seconds, for which Amazon SQS can reuse a data key
@@ -20793,12 +23451,12 @@ type CreateActionTargetInput struct {
// Description is a required field
Description *string `type:"string" required:"true"`
- // The ID for the custom action target.
+ // The ID for the custom action target. Can contain up to 20 alphanumeric characters.
//
// Id is a required field
Id *string `type:"string" required:"true"`
- // The name of the custom action target.
+ // The name of the custom action target. Can contain up to 20 characters.
//
// Name is a required field
Name *string `type:"string" required:"true"`
@@ -26161,7 +28819,7 @@ type ResourceDetails struct {
// Details about an Elastic IP address.
AwsEc2Eip *AwsEc2EipDetails `type:"structure"`
- // Details about an Amazon EC2 instance related to a finding.
+ // Details about an EC2 instance related to a finding.
AwsEc2Instance *AwsEc2InstanceDetails `type:"structure"`
// Details about an EC2 network access control list (ACL).
@@ -26182,6 +28840,13 @@ type ResourceDetails struct {
// Details for an EC2 VPC.
AwsEc2Vpc *AwsEc2VpcDetails `type:"structure"`
+ // Details about an ECS cluster.
+ AwsEcsCluster *AwsEcsClusterDetails `type:"structure"`
+
+ // Details about a task definition. A task definition describes the container
+ // and volume definitions of an Amazon Elastic Container Service task.
+ AwsEcsTaskDefinition *AwsEcsTaskDefinitionDetails `type:"structure"`
+
// Details about an Elastic Beanstalk environment.
AwsElasticBeanstalkEnvironment *AwsElasticBeanstalkEnvironmentDetails `type:"structure"`
@@ -26407,6 +29072,18 @@ func (s *ResourceDetails) SetAwsEc2Vpc(v *AwsEc2VpcDetails) *ResourceDetails {
return s
}
+// SetAwsEcsCluster sets the AwsEcsCluster field's value.
+func (s *ResourceDetails) SetAwsEcsCluster(v *AwsEcsClusterDetails) *ResourceDetails {
+ s.AwsEcsCluster = v
+ return s
+}
+
+// SetAwsEcsTaskDefinition sets the AwsEcsTaskDefinition field's value.
+func (s *ResourceDetails) SetAwsEcsTaskDefinition(v *AwsEcsTaskDefinitionDetails) *ResourceDetails {
+ s.AwsEcsTaskDefinition = v
+ return s
+}
+
// SetAwsElasticBeanstalkEnvironment sets the AwsElasticBeanstalkEnvironment field's value.
func (s *ResourceDetails) SetAwsElasticBeanstalkEnvironment(v *AwsElasticBeanstalkEnvironmentDetails) *ResourceDetails {
s.AwsElasticBeanstalkEnvironment = v
diff --git a/service/transfer/api.go b/service/transfer/api.go
index c729024a27c..0a0de4f1f1e 100644
--- a/service/transfer/api.go
+++ b/service/transfer/api.go
@@ -58,11 +58,11 @@ func (c *Transfer) CreateAccessRequest(input *CreateAccessInput) (req *request.R
// CreateAccess API operation for AWS Transfer Family.
//
// Used by administrators to choose which groups in the directory should have
-// access to upload and download files over the enabled protocols using AWS
-// Transfer Family. For example, a Microsoft Active Directory might contain
-// 50,000 users, but only a small fraction might need the ability to transfer
-// files to the server. An administrator can use CreateAccess to limit the access
-// to the correct set of users who need this ability.
+// access to upload and download files over the enabled protocols using Amazon
+// Web Services Transfer Family. For example, a Microsoft Active Directory might
+// contain 50,000 users, but only a small fraction might need the ability to
+// transfer files to the server. An administrator can use CreateAccess to limit
+// the access to the correct set of users who need this ability.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -73,11 +73,12 @@ func (c *Transfer) CreateAccessRequest(input *CreateAccessInput) (req *request.R
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -86,7 +87,7 @@ func (c *Transfer) CreateAccessRequest(input *CreateAccessInput) (req *request.R
// The requested resource does not exist.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateAccess
@@ -156,9 +157,9 @@ func (c *Transfer) CreateServerRequest(input *CreateServerInput) (req *request.R
// CreateServer API operation for AWS Transfer Family.
//
// Instantiates an auto-scaling virtual server based on the selected file transfer
-// protocol in AWS. When you make updates to your file transfer protocol-enabled
-// server or when you work with users, use the service-generated ServerId property
-// that is assigned to the newly created server.
+// protocol in Amazon Web Services. When you make updates to your file transfer
+// protocol-enabled server or when you work with users, use the service-generated
+// ServerId property that is assigned to the newly created server.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -172,11 +173,12 @@ func (c *Transfer) CreateServerRequest(input *CreateServerInput) (req *request.R
// You do not have sufficient access to perform this action.
//
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -259,9 +261,9 @@ func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Reque
// server. You can only create and associate users with servers that have the
// IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser,
// you can specify the user name, set the home directory, store the user's public
-// key, and assign the user's AWS Identity and Access Management (IAM) role.
-// You can also optionally add a scope-down policy, and assign metadata with
-// tags that can be used to group and search for users.
+// key, and assign the user's Amazon Web Services Identity and Access Management
+// (IAM) role. You can also optionally add a scope-down policy, and assign metadata
+// with tags that can be used to group and search for users.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -272,11 +274,12 @@ func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -285,7 +288,7 @@ func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Reque
// The requested resource does not exist.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser
@@ -367,17 +370,18 @@ func (c *Transfer) DeleteAccessRequest(input *DeleteAccessInput) (req *request.R
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteAccess
@@ -463,17 +467,18 @@ func (c *Transfer) DeleteServerRequest(input *DeleteServerInput) (req *request.R
// You do not have sufficient access to perform this action.
//
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer
@@ -556,17 +561,18 @@ func (c *Transfer) DeleteSshPublicKeyRequest(input *DeleteSshPublicKeyInput) (re
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -657,17 +663,18 @@ func (c *Transfer) DeleteUserRequest(input *DeleteUserInput) (req *request.Reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser
@@ -751,17 +758,18 @@ func (c *Transfer) DescribeAccessRequest(input *DescribeAccessInput) (req *reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeAccess
@@ -844,17 +852,18 @@ func (c *Transfer) DescribeSecurityPolicyRequest(input *DescribeSecurityPolicyIn
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeSecurityPolicy
@@ -938,17 +947,18 @@ func (c *Transfer) DescribeServerRequest(input *DescribeServerInput) (req *reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer
@@ -1032,17 +1042,18 @@ func (c *Transfer) DescribeUserRequest(input *DescribeUserInput) (req *request.R
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser
@@ -1127,11 +1138,12 @@ func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) (re
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -1140,7 +1152,7 @@ func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) (re
// The requested resource does not exist.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -1231,11 +1243,12 @@ func (c *Transfer) ListAccessesRequest(input *ListAccessesInput) (req *request.R
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidNextTokenException
// The NextToken parameter that was passed is invalid.
@@ -1244,7 +1257,7 @@ func (c *Transfer) ListAccessesRequest(input *ListAccessesInput) (req *request.R
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListAccesses
@@ -1383,11 +1396,12 @@ func (c *Transfer) ListSecurityPoliciesRequest(input *ListSecurityPoliciesInput)
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidNextTokenException
// The NextToken parameter that was passed is invalid.
@@ -1520,7 +1534,7 @@ func (c *Transfer) ListServersRequest(input *ListServersInput) (req *request.Req
// ListServers API operation for AWS Transfer Family.
//
// Lists the file transfer protocol-enabled servers that are associated with
-// your AWS account.
+// your Amazon Web Services account.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -1531,11 +1545,12 @@ func (c *Transfer) ListServersRequest(input *ListServersInput) (req *request.Req
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidNextTokenException
// The NextToken parameter that was passed is invalid.
@@ -1679,11 +1694,12 @@ func (c *Transfer) ListTagsForResourceRequest(input *ListTagsForResourceInput) (
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidNextTokenException
// The NextToken parameter that was passed is invalid.
@@ -1827,11 +1843,12 @@ func (c *Transfer) ListUsersRequest(input *ListUsersInput) (req *request.Request
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidNextTokenException
// The NextToken parameter that was passed is invalid.
@@ -1840,7 +1857,7 @@ func (c *Transfer) ListUsersRequest(input *ListUsersInput) (req *request.Request
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers
@@ -1981,17 +1998,18 @@ func (c *Transfer) StartServerRequest(input *StartServerInput) (req *request.Req
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -2089,17 +2107,18 @@ func (c *Transfer) StopServerRequest(input *StopServerInput) (req *request.Reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -2188,17 +2207,18 @@ func (c *Transfer) TagResourceRequest(input *TagResourceInput) (req *request.Req
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource
@@ -2283,17 +2303,18 @@ func (c *Transfer) TestIdentityProviderRequest(input *TestIdentityProviderInput)
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider
@@ -2377,17 +2398,18 @@ func (c *Transfer) UntagResourceRequest(input *UntagResourceInput) (req *request
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource
@@ -2468,11 +2490,12 @@ func (c *Transfer) UpdateAccessRequest(input *UpdateAccessInput) (req *request.R
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -2481,7 +2504,7 @@ func (c *Transfer) UpdateAccessRequest(input *UpdateAccessInput) (req *request.R
// The requested resource does not exist.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateAccess
@@ -2567,7 +2590,8 @@ func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.R
// You do not have sufficient access to perform this action.
//
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * ConflictException
// This exception is thrown when the UpdatServer is called for a file transfer
@@ -2575,8 +2599,8 @@ func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.R
// VpcEndpointID is not in the available state.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
@@ -2585,7 +2609,7 @@ func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.R
// The requested resource does not exist.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -2674,17 +2698,18 @@ func (c *Transfer) UpdateUserRequest(input *UpdateUserInput) (req *request.Reque
//
// Returned Error Types:
// * ServiceUnavailableException
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
//
// * InternalServiceError
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
//
// * InvalidRequestException
// This exception is thrown when the client submits a malformed request.
//
// * ResourceNotFoundException
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
//
// * ThrottlingException
@@ -2833,9 +2858,9 @@ type CreateAccessInput struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -2860,10 +2885,10 @@ type CreateAccessInput struct {
// and keys should be visible to your user and how you want to make them visible.
// You must specify the Entry and Target pair, where Entry shows how the path
// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
- // you only specify a target, it will be displayed as is. You also must ensure
- // that your AWS Identity and Access Management (IAM) role provides access to
- // paths in Target. This value can only be set when HomeDirectoryType is set
- // to LOGICAL.
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
// The following is an Entry and Target pair example.
//
@@ -2876,17 +2901,15 @@ type CreateAccessInput struct {
//
// The following is an Entry and Target pair example for chroot.
//
- // [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
+ // [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
//
// If the target of a logical directory entry does not exist in Amazon S3 or
- // Amazon EFS, the entry will be ignored. As a workaround, you can use the Amazon
- // S3 API or EFS API to create 0-byte objects as place holders for your directory.
- // If using the AWS CLI, use the s3api or efsapi call instead of s3 or efs so
- // you can use the put-object operation. For example, you can use the following.
- //
- // aws s3api put-object --bucket bucketname --key path/to/folder/
- //
- // The end of the key name must end in a / for it to be considered a folder.
+ // EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
+ // or EFS API to create 0 byte objects as place holders for your directory.
+ // If using the CLI, use the s3api or efsapi call instead of s3 or efs so you
+ // can use the put-object operation. For example, you use the following: aws
+ // s3api put-object --bucket bucketname --key path/to/folder/. Make sure that
+ // the end of the key name ends in a / for it to be considered a folder.
HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`
// The type of landing directory (folder) you want your users' home directory
@@ -2905,14 +2928,14 @@ type CreateAccessInput struct {
// This only applies when domain of ServerId is S3. Amazon EFS does not use
// scope-down policies.
//
- // For scope-down policies, AWS Transfer Family stores the policy as a JSON
- // blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
- // policy as a JSON blob and pass it in the Policy argument.
+ // For scope-down policies, Amazon Web Services Transfer Family stores the policy
+ // as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
+ // You save the policy as a JSON blob and pass it in the Policy argument.
//
// For an example of a scope-down policy, see Example scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html).
//
// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
- // in the AWS Security Token Service API Reference.
+ // in the Amazon Web Services Security Token Service API Reference.
Policy *string `type:"string"`
// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
@@ -3047,7 +3070,8 @@ type CreateAccessOutput struct {
_ struct{} `type:"structure"`
// The external ID of the group whose users have access to your Amazon S3 or
- // Amazon EFS resources over the enabled protocols using AWS Transfer Family.
+ // Amazon EFS resources over the enabled protocols using Amazon Web Services
+ // Transfer Family.
//
// ExternalId is a required field
ExternalId *string `min:"1" type:"string" required:"true"`
@@ -3083,19 +3107,19 @@ func (s *CreateAccessOutput) SetServerId(v string) *CreateAccessOutput {
type CreateServerInput struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
- // Required when Protocols is set to FTPS.
+ // The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager
+ // (ACM) certificate. Required when Protocols is set to FTPS.
//
// To request a new public certificate, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web Services Certificate Manager User Guide.
//
// To import an existing certificate into ACM, see Importing certificates into
// ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web Services Certificate Manager User Guide.
//
// To request a private certificate to use FTPS through private IP addresses,
// see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web Services Certificate Manager User Guide.
//
// Certificates with the following cryptographic algorithms and key sizes are
// supported:
@@ -3135,10 +3159,10 @@ type CreateServerInput struct {
// facing by attaching Elastic IP addresses directly to it.
//
// After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
- // in your AWS account if your account hasn't already done so before May 19,
- // 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
- // in your AWS account on or before May 19, 2021, you will not be affected.
- // After this date, use EndpointType=VPC.
+ // in your Amazon Web Services account if your account hasn't already done so
+ // before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
+ // in your Amazon Web Services account on or before May 19, 2021, you will not
+ // be affected. After this date, use EndpointType=VPC.
//
// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
//
@@ -3158,7 +3182,7 @@ type CreateServerInput struct {
//
// For more information, see Change the host key for your SFTP-enabled server
// (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
- // in the AWS Transfer Family User Guide.
+ // in the Amazon Web Services Transfer Family User Guide.
HostKey *string `type:"string" sensitive:"true"`
// Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY.
@@ -3169,19 +3193,25 @@ type CreateServerInput struct {
IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
// Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
- // which allows you to store and access user credentials within the AWS Transfer
- // Family service. Use AWS_DIRECTORY_SERVICE to provide access to Active Directory
- // groups in AWS Managed Active Directory or Microsoft Active Directory in your
- // on-premises environment or in AWS using AD Connectors. This option also requires
- // you to provide a Directory ID using the IdentityProviderDetails parameter.
+ // which allows you to store and access user credentials within the Amazon Web
+ // Services Transfer Family service.
+ //
+ // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
+ // Amazon Web Services Managed Active Directory or Microsoft Active Directory
+ // in your on-premises environment or in Amazon Web Services using AD Connectors.
+ // This option also requires you to provide a Directory ID using the IdentityProviderDetails
+ // parameter.
+ //
// Use the API_GATEWAY value to integrate with an identity provider of your
// choosing. The API_GATEWAY setting requires you to provide an API Gateway
// endpoint URL to call for authentication using the IdentityProviderDetails
// parameter.
IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // Allows the service to write your users' activity to your Amazon CloudWatch
- // logs for monitoring and auditing purposes.
+ // Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
+ // and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
+ // logging for Amazon S3 or Amazon EFS events. When set, user activity can be
+ // viewed in your CloudWatch logs.
LoggingRole *string `min:"20" type:"string"`
// Specifies the file transfer protocol or protocols over which your file transfer
@@ -3195,9 +3225,9 @@ type CreateServerInput struct {
//
// * FTP (File Transfer Protocol): Unencrypted file transfer
//
- // If you select FTPS, you must choose a certificate stored in AWS Certificate
- // Manager (ACM) which will be used to identify your server when clients connect
- // to it over FTPS.
+ // If you select FTPS, you must choose a certificate stored in Amazon Web Services
+ // Certificate Manager (ACM) which is used to identify your server when clients
+ // connect to it over FTPS.
//
// If Protocol includes either FTP or FTPS, then the EndpointType must be VPC
// and the IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
@@ -3364,13 +3394,14 @@ type CreateUserInput struct {
// A HomeDirectory example is /bucket_name/home/mydirectory.
HomeDirectory *string `type:"string"`
- // Logical directory mappings that specify what Amazon S3 or EFS paths and keys
- // should be visible to your user and how you want to make them visible. You
- // will need to specify the Entry and Target pair, where Entry shows how the
- // path is made visible and Target is the actual Amazon S3 or EFS path. If you
- // only specify a target, it will be displayed as is. You will need to also
- // make sure that your IAM role provides access to paths in Target. This value
- // can only be set when HomeDirectoryType is set to LOGICAL.
+ // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
+ // and keys should be visible to your user and how you want to make them visible.
+ // You must specify the Entry and Target pair, where Entry shows how the path
+ // is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
// The following is an Entry and Target pair example.
//
@@ -3383,11 +3414,11 @@ type CreateUserInput struct {
//
// The following is an Entry and Target pair example for chroot.
//
- // [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
+ // [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
//
// If the target of a logical directory entry does not exist in Amazon S3 or
- // EFS, the entry will be ignored. As a workaround, you can use the Amazon S3
- // API or EFS API to create 0 byte objects as place holders for your directory.
+ // EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
+ // or EFS API to create 0 byte objects as place holders for your directory.
// If using the CLI, use the s3api or efsapi call instead of s3 or efs so you
// can use the put-object operation. For example, you use the following: aws
// s3api put-object --bucket bucketname --key path/to/folder/. Make sure that
@@ -3410,14 +3441,14 @@ type CreateUserInput struct {
// This only applies when domain of ServerId is S3. EFS does not use scope down
// policy.
//
- // For scope-down policies, AWS Transfer Family stores the policy as a JSON
- // blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
- // policy as a JSON blob and pass it in the Policy argument.
+ // For scope-down policies, Amazon Web Services Transfer Family stores the policy
+ // as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
+ // You save the policy as a JSON blob and pass it in the Policy argument.
//
// For an example of a scope-down policy, see Example scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html).
//
// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
- // in the AWS Security Token Service API Reference.
+ // in the Amazon Web Services Security Token Service API Reference.
Policy *string `type:"string"`
// Specifies the full POSIX identity, including user ID (Uid), group ID (Gid),
@@ -3631,9 +3662,9 @@ type DeleteAccessInput struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -3935,9 +3966,9 @@ type DescribeAccessInput struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -4176,8 +4207,8 @@ type DescribeUserInput struct {
ServerId *string `min:"19" type:"string" required:"true"`
// The name of the user assigned to one or more servers. User names are part
- // of the sign-in credentials to use the AWS Transfer Family service and perform
- // file transfer tasks.
+ // of the sign-in credentials to use the Amazon Web Services Transfer Family
+ // service and perform file transfer tasks.
//
// UserName is a required field
UserName *string `min:"3" type:"string" required:"true"`
@@ -4270,9 +4301,9 @@ type DescribedAccess struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -4291,13 +4322,14 @@ type DescribedAccess struct {
// A HomeDirectory example is /bucket_name/home/mydirectory.
HomeDirectory *string `type:"string"`
- // Specifies the logical directory mappings that specify what Amazon S3 or Amazon
- // EFS paths and keys should be visible to the associated access and how you
- // want to make them visible. You must specify the "Entry" and "Target" pair,
- // where Entry shows how the path is made visible and Target is the actual Amazon
- // S3 or EFS path. If you only specify a target, it will be displayed as is.
- // You also must ensure that your AWS Identity and Access Management (IAM) role
- // provides access to paths in Target.
+ // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
+ // and keys should be visible to your user and how you want to make them visible.
+ // You must specify the Entry and Target pair, where Entry shows how the path
+ // is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
// In most cases, you can use this value instead of the scope-down policy to
// lock down the associated access to the designated home directory ("chroot").
@@ -4474,15 +4506,18 @@ type DescribedServer struct {
// Arn is a required field
Arn *string `min:"20" type:"string" required:"true"`
- // Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required
- // when Protocols is set to FTPS.
+ // Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
+ // Required when Protocols is set to FTPS.
Certificate *string `type:"string"`
// Specifies the domain of the storage system that is used for file transfers.
Domain *string `type:"string" enum:"Domain"`
- // Specifies the virtual private cloud (VPC) endpoint settings that you configured
- // for your server.
+ // The virtual private cloud (VPC) endpoint settings that are configured for
+ // your server. When you host your endpoint within your VPC, you can make it
+ // accessible only to resources within your VPC, or you can attach Elastic IP
+ // addresses and make it accessible to clients over the internet. Your VPC's
+ // default security groups are automatically assigned to your endpoint.
EndpointDetails *EndpointDetails `type:"structure"`
// Defines the type of endpoint that your server is connected to. If your server
@@ -4500,21 +4535,35 @@ type DescribedServer struct {
// or SERVICE_MANAGED.
IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
- // Specifies the mode of authentication method enabled for this service. A value
- // of AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory
- // groups in AWS Managed Active Directory or Microsoft Active Directory in your
- // on-premises environment or in AWS using AD Connectors. A value of SERVICE_MANAGED
- // means that you are using this server to store and access user credentials
- // within the service. A value of API_GATEWAY indicates that you have integrated
- // an API Gateway endpoint that will be invoked for authenticating your user
- // into the service.
+ // Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
+ // which allows you to store and access user credentials within the Amazon Web
+ // Services Transfer Family service.
+ //
+ // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
+ // Amazon Web Services Managed Active Directory or Microsoft Active Directory
+ // in your on-premises environment or in Amazon Web Services using AD Connectors.
+ // This option also requires you to provide a Directory ID using the IdentityProviderDetails
+ // parameter.
+ //
+ // Use the API_GATEWAY value to integrate with an identity provider of your
+ // choosing. The API_GATEWAY setting requires you to provide an API Gateway
+ // endpoint URL to call for authentication using the IdentityProviderDetails
+ // parameter.
IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // Specifies the AWS Identity and Access Management (IAM) role that allows a
- // server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
- // When set, user activity can be viewed in your CloudWatch logs.
+ // Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
+ // and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
+ // logging for Amazon S3 or Amazon EFS events. When set, user activity can be
+ // viewed in your CloudWatch logs.
LoggingRole *string `min:"20" type:"string"`
+ // The protocol settings that are configured for your server.
+ //
+ // Use the PassiveIp parameter to indicate passive mode. Enter a single dotted-quad
+ // IPv4 address, such as the external IP address of a firewall, router, or load
+ // balancer.
+ ProtocolDetails *ProtocolDetails `type:"structure"`
+
// Specifies the file transfer protocol or protocols over which your file transfer
// protocol client can connect to your server's endpoint. The available protocols
// are:
@@ -4616,6 +4665,12 @@ func (s *DescribedServer) SetLoggingRole(v string) *DescribedServer {
return s
}
+// SetProtocolDetails sets the ProtocolDetails field's value.
+func (s *DescribedServer) SetProtocolDetails(v *ProtocolDetails) *DescribedServer {
+ s.ProtocolDetails = v
+ return s
+}
+
// SetProtocols sets the Protocols field's value.
func (s *DescribedServer) SetProtocols(v []*string) *DescribedServer {
s.Protocols = v
@@ -4668,13 +4723,14 @@ type DescribedUser struct {
// A HomeDirectory example is /bucket_name/home/mydirectory.
HomeDirectory *string `type:"string"`
- // Specifies the logical directory mappings that specify what Amazon S3 or EFS
- // paths and keys should be visible to your user and how you want to make them
- // visible. You will need to specify the "Entry" and "Target" pair, where Entry
- // shows how the path is made visible and Target is the actual Amazon S3 or
- // EFS path. If you only specify a target, it will be displayed as is. You will
- // need to also make sure that your AWS Identity and Access Management (IAM)
- // role provides access to paths in Target.
+ // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
+ // and keys should be visible to your user and how you want to make them visible.
+ // You must specify the Entry and Target pair, where Entry shows how the path
+ // is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
// In most cases, you can use this value instead of the scope-down policy to
// lock your user down to the designated home directory ("chroot"). To do this,
@@ -4802,10 +4858,10 @@ func (s *DescribedUser) SetUserName(v string) *DescribedUser {
// IP address to your server's endpoint.
//
// After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
-// in your AWS account if your account hasn't already done so before May 19,
-// 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
-// in your AWS account on or before May 19, 2021, you will not be affected.
-// After this date, use EndpointType=VPC.
+// in your Amazon Web Servicesaccount if your account hasn't already done so
+// before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
+// in your Amazon Web Servicesaccount on or before May 19, 2021, you will not
+// be affected. After this date, use EndpointType=VPC.
//
// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
type EndpointDetails struct {
@@ -4903,10 +4959,22 @@ func (s *EndpointDetails) SetVpcId(v string) *EndpointDetails {
}
// Represents an object that contains entries and targets for HomeDirectoryMappings.
+//
+// The following is an Entry and Target pair example for chroot.
+//
+// [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
+//
+// If the target of a logical directory entry does not exist in Amazon S3 or
+// EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
+// or EFS API to create 0 byte objects as place holders for your directory.
+// If using the CLI, use the s3api or efsapi call instead of s3 or efs so you
+// can use the put-object operation. For example, you use the following: aws
+// s3api put-object --bucket bucketname --key path/to/folder/. Make sure that
+// the end of the key name ends in a / for it to be considered a folder.
type HomeDirectoryMapEntry struct {
_ struct{} `type:"structure"`
- // Represents an entry and a target for HomeDirectoryMappings.
+ // Represents an entry for HomeDirectoryMappings.
//
// Entry is a required field
Entry *string `type:"string" required:"true"`
@@ -4961,8 +5029,8 @@ func (s *HomeDirectoryMapEntry) SetTarget(v string) *HomeDirectoryMapEntry {
type IdentityProviderDetails struct {
_ struct{} `type:"structure"`
- // The identifier of the AWS Directory Service directory that you want to stop
- // sharing.
+ // The identifier of the Amazon Web ServicesDirectory Service directory that
+ // you want to stop sharing.
DirectoryId *string `min:"12" type:"string"`
// Provides the type of InvocationRole used to authenticate the user account.
@@ -5138,8 +5206,8 @@ func (s *ImportSshPublicKeyOutput) SetUserName(v string) *ImportSshPublicKeyOutp
return s
}
-// This exception is thrown when an error occurs in the AWS Transfer Family
-// service.
+// This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+// Family service.
type InternalServiceError struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -5603,8 +5671,8 @@ type ListTagsForResourceInput struct {
_ struct{} `type:"structure"`
// Requests the tags associated with a particular Amazon Resource Name (ARN).
- // An ARN is an identifier for a specific AWS resource, such as a server, user,
- // or role.
+ // An ARN is an identifier for a specific Amazon Web Services resource, such
+ // as a server, user, or role.
//
// Arn is a required field
Arn *string `min:"20" type:"string" required:"true"`
@@ -5836,9 +5904,9 @@ type ListedAccess struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -5925,14 +5993,26 @@ type ListedServer struct {
// the public internet.
EndpointType *string `type:"string" enum:"EndpointType"`
- // Specifies the authentication method used to validate a user for a server
- // that was specified. This can include Secure Shell (SSH), Active Directory
- // groups, user name and password combinations, or your own custom authentication
- // method.
+ // Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
+ // which allows you to store and access user credentials within the Amazon Web
+ // Services Transfer Family service.
+ //
+ // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in
+ // Amazon Web Services Managed Active Directory or Microsoft Active Directory
+ // in your on-premises environment or in Amazon Web Services using AD Connectors.
+ // This option also requires you to provide a Directory ID using the IdentityProviderDetails
+ // parameter.
+ //
+ // Use the API_GATEWAY value to integrate with an identity provider of your
+ // choosing. The API_GATEWAY setting requires you to provide an API Gateway
+ // endpoint URL to call for authentication using the IdentityProviderDetails
+ // parameter.
IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // Specifies the AWS Identity and Access Management (IAM) role that allows a
- // server to turn on Amazon CloudWatch logging.
+ // Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
+ // and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
+ // logging for Amazon S3 or Amazon EFS events. When set, user activity can be
+ // viewed in your CloudWatch logs.
LoggingRole *string `min:"20" type:"string"`
// Specifies the unique system assigned identifier for the servers that were
@@ -6171,6 +6251,39 @@ func (s *PosixProfile) SetUid(v int64) *PosixProfile {
return s
}
+// The protocol settings that are configured for your server.
+//
+// This type is only valid in the UpdateServer API.
+type ProtocolDetails struct {
+ _ struct{} `type:"structure"`
+
+ // Indicates passive mode, for FTP and FTPS protocols. Enter a single dotted-quad
+ // IPv4 address, such as the external IP address of a firewall, router, or load
+ // balancer. For example:
+ //
+ // aws transfer update-server --protocol-details PassiveIp=0.0.0.0
+ //
+ // Replace 0.0.0.0 in the example above with the actual IP address you want
+ // to use.
+ PassiveIp *string `type:"string"`
+}
+
+// String returns the string representation
+func (s ProtocolDetails) String() string {
+ return awsutil.Prettify(s)
+}
+
+// GoString returns the string representation
+func (s ProtocolDetails) GoString() string {
+ return s.String()
+}
+
+// SetPassiveIp sets the PassiveIp field's value.
+func (s *ProtocolDetails) SetPassiveIp(v string) *ProtocolDetails {
+ s.PassiveIp = &v
+ return s
+}
+
// The requested resource does not exist.
type ResourceExistsException struct {
_ struct{} `type:"structure"`
@@ -6233,7 +6346,7 @@ func (s *ResourceExistsException) RequestID() string {
return s.RespMetadata.RequestID
}
-// This exception is thrown when a resource is not found by the AWS Transfer
+// This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
type ResourceNotFoundException struct {
_ struct{} `type:"structure"`
@@ -6296,7 +6409,8 @@ func (s *ResourceNotFoundException) RequestID() string {
return s.RespMetadata.RequestID
}
-// The request has failed because the AWS Transfer Family service is not available.
+// The request has failed because the Amazon Web ServicesTransfer Family service
+// is not available.
type ServiceUnavailableException struct {
_ struct{} `type:"structure"`
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
@@ -6577,8 +6691,8 @@ func (s *Tag) SetValue(v string) *Tag {
type TagResourceInput struct {
_ struct{} `type:"structure"`
- // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server,
- // user, or role.
+ // An Amazon Resource Name (ARN) for a specific Amazon Web Services resource,
+ // such as a server, user, or role.
//
// Arn is a required field
Arn *string `min:"20" type:"string" required:"true"`
@@ -6871,8 +6985,8 @@ type UntagResourceInput struct {
_ struct{} `type:"structure"`
// The value of the resource that will have the tag removed. An Amazon Resource
- // Name (ARN) is an identifier for a specific AWS resource, such as a server,
- // user, or role.
+ // Name (ARN) is an identifier for a specific Amazon Web Services resource,
+ // such as a server, user, or role.
//
// Arn is a required field
Arn *string `min:"20" type:"string" required:"true"`
@@ -6948,9 +7062,9 @@ type UpdateAccessInput struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your
- // Amazon S3 or Amazon EFS resources over the enabled protocols using AWS Transfer
- // Family. If you know the group name, you can view the SID values by running
- // the following command using Windows PowerShell.
+ // Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon
+ // Web Services Transfer Family. If you know the group name, you can view the
+ // SID values by running the following command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties *
// | Select SamAccountName,ObjectSid
@@ -6975,10 +7089,10 @@ type UpdateAccessInput struct {
// and keys should be visible to your user and how you want to make them visible.
// You must specify the Entry and Target pair, where Entry shows how the path
// is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
- // you only specify a target, it will be displayed as is. You also must ensure
- // that your AWS Identity and Access Management (IAM) role provides access to
- // paths in Target. This value can only be set when HomeDirectoryType is set
- // to LOGICAL.
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
// The following is an Entry and Target pair example.
//
@@ -6991,17 +7105,15 @@ type UpdateAccessInput struct {
//
// The following is an Entry and Target pair example for chroot.
//
- // [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
+ // [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
//
// If the target of a logical directory entry does not exist in Amazon S3 or
- // Amazon EFS, the entry will be ignored. As a workaround, you can use the Amazon
- // S3 API or EFS API to create 0-byte objects as place holders for your directory.
- // If using the AWS CLI, use the s3api or efsapi call instead of s3 or efs so
- // you can use the put-object operation. For example, you can use the following.
- //
- // aws s3api put-object --bucket bucketname --key path/to/folder/
- //
- // The end of the key name must end in a / for it to be considered a folder.
+ // EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
+ // or EFS API to create 0 byte objects as place holders for your directory.
+ // If using the CLI, use the s3api or efsapi call instead of s3 or efs so you
+ // can use the put-object operation. For example, you use the following: aws
+ // s3api put-object --bucket bucketname --key path/to/folder/. Make sure that
+ // the end of the key name ends in a / for it to be considered a folder.
HomeDirectoryMappings []*HomeDirectoryMapEntry `min:"1" type:"list"`
// The type of landing directory (folder) you want your users' home directory
@@ -7020,14 +7132,14 @@ type UpdateAccessInput struct {
// This only applies when domain of ServerId is S3. Amazon EFS does not use
// scope down policy.
//
- // For scope-down policies, AWS Transfer Family stores the policy as a JSON
- // blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
- // policy as a JSON blob and pass it in the Policy argument.
+ // For scope-down policies, Amazon Web ServicesTransfer Family stores the policy
+ // as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
+ // You save the policy as a JSON blob and pass it in the Policy argument.
//
// For an example of a scope-down policy, see Example scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html).
//
// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
- // in the AWS Security Token Service API Reference.
+ // in the Amazon Web ServicesSecurity Token Service API Reference.
Policy *string `type:"string"`
// The full POSIX identity, including user ID (Uid), group ID (Gid), and any
@@ -7157,7 +7269,8 @@ type UpdateAccessOutput struct {
_ struct{} `type:"structure"`
// The external ID of the group whose users have access to your Amazon S3 or
- // Amazon EFS resources over the enabled protocols using AWS Transfer Family.
+ // Amazon EFS resources over the enabled protocols using Amazon Web ServicesTransfer
+ // Family.
//
// ExternalId is a required field
ExternalId *string `min:"1" type:"string" required:"true"`
@@ -7193,19 +7306,19 @@ func (s *UpdateAccessOutput) SetServerId(v string) *UpdateAccessOutput {
type UpdateServerInput struct {
_ struct{} `type:"structure"`
- // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
- // Required when Protocols is set to FTPS.
+ // The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager
+ // (ACM) certificate. Required when Protocols is set to FTPS.
//
// To request a new public certificate, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web ServicesCertificate Manager User Guide.
//
// To import an existing certificate into ACM, see Importing certificates into
// ACM (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web ServicesCertificate Manager User Guide.
//
// To request a private certificate to use FTPS through private IP addresses,
// see Request a private certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html)
- // in the AWS Certificate Manager User Guide.
+ // in the Amazon Web ServicesCertificate Manager User Guide.
//
// Certificates with the following cryptographic algorithms and key sizes are
// supported:
@@ -7225,10 +7338,10 @@ type UpdateServerInput struct {
Certificate *string `type:"string"`
// The virtual private cloud (VPC) endpoint settings that are configured for
- // your server. With a VPC endpoint, you can restrict access to your server
- // to resources only within your VPC. To control incoming internet traffic,
- // you will need to associate one or more Elastic IP addresses with your server's
- // endpoint.
+ // your server. When you host your endpoint within your VPC, you can make it
+ // accessible only to resources within your VPC, or you can attach Elastic IP
+ // addresses and make it accessible to clients over the internet. Your VPC's
+ // default security groups are automatically assigned to your endpoint.
EndpointDetails *EndpointDetails `type:"structure"`
// The type of endpoint that you want your server to use. You can choose to
@@ -7238,10 +7351,10 @@ type UpdateServerInput struct {
// facing by attaching Elastic IP addresses directly to it.
//
// After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
- // in your AWS account if your account hasn't already done so before May 19,
- // 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
- // in your AWS account on or before May 19, 2021, you will not be affected.
- // After this date, use EndpointType=VPC.
+ // in your Amazon Web Servicesaccount if your account hasn't already done so
+ // before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT
+ // in your Amazon Web Servicesaccount on or before May 19, 2021, you will not
+ // be affected. After this date, use EndpointType=VPC.
//
// For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
//
@@ -7260,18 +7373,26 @@ type UpdateServerInput struct {
//
// For more information, see Change the host key for your SFTP-enabled server
// (https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key)
- // in the AWS Transfer Family User Guide.
+ // in the Amazon Web ServicesTransfer Family User Guide.
HostKey *string `type:"string" sensitive:"true"`
// An array containing all of the information required to call a customer's
// authentication API method.
IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
- // Changes the AWS Identity and Access Management (IAM) role that allows Amazon
- // S3 or Amazon EFS events to be logged in Amazon CloudWatch, turning logging
- // on or off.
+ // Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity
+ // and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch
+ // logging for Amazon S3 or Amazon EFS events. When set, user activity can be
+ // viewed in your CloudWatch logs.
LoggingRole *string `type:"string"`
+ // The protocol settings that are configured for your server.
+ //
+ // Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).
+ // Enter a single dotted-quad IPv4 address, such as the external IP address
+ // of a firewall, router, or load balancer.
+ ProtocolDetails *ProtocolDetails `type:"structure"`
+
// Specifies the file transfer protocol or protocols over which your file transfer
// protocol client can connect to your server's endpoint. The available protocols
// are:
@@ -7283,7 +7404,7 @@ type UpdateServerInput struct {
//
// * File Transfer Protocol (FTP): Unencrypted file transfer
//
- // If you select FTPS, you must choose a certificate stored in AWS Certificate
+ // If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate
// Manager (ACM) which will be used to identify your server when clients connect
// to it over FTPS.
//
@@ -7381,6 +7502,12 @@ func (s *UpdateServerInput) SetLoggingRole(v string) *UpdateServerInput {
return s
}
+// SetProtocolDetails sets the ProtocolDetails field's value.
+func (s *UpdateServerInput) SetProtocolDetails(v *ProtocolDetails) *UpdateServerInput {
+ s.ProtocolDetails = v
+ return s
+}
+
// SetProtocols sets the Protocols field's value.
func (s *UpdateServerInput) SetProtocols(v []*string) *UpdateServerInput {
s.Protocols = v
@@ -7436,23 +7563,30 @@ type UpdateUserInput struct {
// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths
// and keys should be visible to your user and how you want to make them visible.
- // You will need to specify the "Entry" and "Target" pair, where Entry shows
- // how the path is made visible and Target is the actual Amazon S3 or Amazon
- // EFS path. If you only specify a target, it will be displayed as is. You will
- // need to also make sure that your IAM role provides access to paths in Target.
- // The following is an example.
+ // You must specify the Entry and Target pair, where Entry shows how the path
+ // is made visible and Target is the actual Amazon S3 or Amazon EFS path. If
+ // you only specify a target, it is displayed as is. You also must ensure that
+ // your Amazon Web Services Identity and Access Management (IAM) role provides
+ // access to paths in Target. This value can only be set when HomeDirectoryType
+ // is set to LOGICAL.
//
- // '[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target":
- // "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'
+ // The following is an Entry and Target pair example.
+ //
+ // [ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf"
+ // } ]
//
// In most cases, you can use this value instead of the scope-down policy to
// lock down your user to the designated home directory ("chroot"). To do this,
// you can set Entry to '/' and set Target to the HomeDirectory parameter value.
//
+ // The following is an Entry and Target pair example for chroot.
+ //
+ // [ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
+ //
// If the target of a logical directory entry does not exist in Amazon S3 or
- // EFS, the entry will be ignored. As a workaround, you can use the Amazon S3
- // API or EFS API to create 0-byte objects as place holders for your directory.
- // If using the AWS CLI, use the s3api or efsapi call instead of s3 efs so you
+ // EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API
+ // or EFS API to create 0 byte objects as place holders for your directory.
+ // If using the CLI, use the s3api or efsapi call instead of s3 or efs so you
// can use the put-object operation. For example, you use the following: aws
// s3api put-object --bucket bucketname --key path/to/folder/. Make sure that
// the end of the key name ends in a / for it to be considered a folder.
@@ -7474,14 +7608,14 @@ type UpdateUserInput struct {
// This only applies when domain of ServerId is S3. Amazon EFS does not use
// scope-down policies.
//
- // For scope-down policies, AWS Transfer Family stores the policy as a JSON
- // blob, instead of the Amazon Resource Name (ARN) of the policy. You save the
- // policy as a JSON blob and pass it in the Policy argument.
+ // For scope-down policies, Amazon Web ServicesTransfer Family stores the policy
+ // as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.
+ // You save the policy as a JSON blob and pass it in the Policy argument.
//
// For an example of a scope-down policy, see Creating a scope-down policy (https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down).
//
// For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html)
- // in the AWS Security Token Service API Reference.
+ // in the Amazon Web Services Security Token Service API Reference.
Policy *string `type:"string"`
// Specifies the full POSIX identity, including user ID (Uid), group ID (Gid),
diff --git a/service/transfer/doc.go b/service/transfer/doc.go
index fcbf894a252..0749b6af02d 100644
--- a/service/transfer/doc.go
+++ b/service/transfer/doc.go
@@ -3,17 +3,18 @@
// Package transfer provides the client and types for making API
// requests to AWS Transfer Family.
//
-// AWS Transfer Family is a fully managed service that enables the transfer
-// of files over the File Transfer Protocol (FTP), File Transfer Protocol over
-// SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly
-// into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you
-// seamlessly migrate your file transfer workflows to AWS Transfer Family by
-// integrating with existing authentication systems, and providing DNS routing
-// with Amazon Route 53 so nothing changes for your customers and partners,
-// or their applications. With your data in Amazon S3, you can use it with AWS
-// services for processing, analytics, machine learning, and archiving. Getting
-// started with AWS Transfer Family is easy since there is no infrastructure
-// to buy and set up.
+// Amazon Web Services Transfer Family is a fully managed service that enables
+// the transfer of files over the File Transfer Protocol (FTP), File Transfer
+// Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP)
+// directly into and out of Amazon Simple Storage Service (Amazon S3). Amazon
+// Web Services helps you seamlessly migrate your file transfer workflows to
+// Amazon Web Services Transfer Family by integrating with existing authentication
+// systems, and providing DNS routing with Amazon Route 53 so nothing changes
+// for your customers and partners, or their applications. With your data in
+// Amazon S3, you can use it with Amazon Web Services services for processing,
+// analytics, machine learning, and archiving. Getting started with Amazon Web
+// Services Transfer Family is easy since there is no infrastructure to buy
+// and set up.
//
// See https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05 for more information on this service.
//
diff --git a/service/transfer/errors.go b/service/transfer/errors.go
index d4a863ac52f..831745832d0 100644
--- a/service/transfer/errors.go
+++ b/service/transfer/errors.go
@@ -25,8 +25,8 @@ const (
// ErrCodeInternalServiceError for service response error code
// "InternalServiceError".
//
- // This exception is thrown when an error occurs in the AWS Transfer Family
- // service.
+ // This exception is thrown when an error occurs in the Amazon Web ServicesTransfer
+ // Family service.
ErrCodeInternalServiceError = "InternalServiceError"
// ErrCodeInvalidNextTokenException for service response error code
@@ -50,14 +50,15 @@ const (
// ErrCodeResourceNotFoundException for service response error code
// "ResourceNotFoundException".
//
- // This exception is thrown when a resource is not found by the AWS Transfer
+ // This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer
// Family service.
ErrCodeResourceNotFoundException = "ResourceNotFoundException"
// ErrCodeServiceUnavailableException for service response error code
// "ServiceUnavailableException".
//
- // The request has failed because the AWS Transfer Family service is not available.
+ // The request has failed because the Amazon Web ServicesTransfer Family service
+ // is not available.
ErrCodeServiceUnavailableException = "ServiceUnavailableException"
// ErrCodeThrottlingException for service response error code
diff --git a/service/wafv2/api.go b/service/wafv2/api.go
index 641b5e4ae0f..b068149d6d0 100644
--- a/service/wafv2/api.go
+++ b/service/wafv2/api.go
@@ -58,14 +58,14 @@ func (c *WAFV2) AssociateWebACLRequest(input *AssociateWebACLInput) (req *reques
// AssociateWebACL API operation for AWS WAFV2.
//
-// Associates a Web ACL with a regional application resource, to protect the
+// Associates a web ACL with a regional application resource, to protect the
// resource. A regional application can be an Application Load Balancer (ALB),
-// an API Gateway REST API, or an AppSync GraphQL API.
+// an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
-// For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution
-// configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution,
-// set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For
-// information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).
+// For Amazon CloudFront, don't use this call. Instead, use your CloudFront
+// distribution configuration. To associate a web ACL, in the CloudFront call
+// UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN)
+// of the web ACL. For information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -76,14 +76,14 @@ func (c *WAFV2) AssociateWebACLRequest(input *AssociateWebACLInput) (req *reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -92,14 +92,13 @@ func (c *WAFV2) AssociateWebACLRequest(input *AssociateWebACLInput) (req *reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -174,13 +173,13 @@ func (c *WAFV2) CheckCapacityRequest(input *CheckCapacityInput) (req *request.Re
// and set of rules. You can use this to check the capacity requirements for
// the rules you want to use in a RuleGroup or WebACL.
//
-// AWS WAF uses WCUs to calculate and control the operating resources that are
-// used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity
-// differently for each rule type, to reflect the relative cost of each rule.
-// Simple rules that cost little to run use fewer WCUs than more complex rules
-// that use more processing power. Rule group capacity is fixed at creation,
-// which helps users plan their web ACL WCU usage when they use a rule group.
-// The WCU limit for web ACLs is 1,500.
+// WAF uses WCUs to calculate and control the operating resources that are used
+// to run your rules, rule groups, and web ACLs. WAF calculates capacity differently
+// for each rule type, to reflect the relative cost of each rule. Simple rules
+// that cost little to run use fewer WCUs than more complex rules that use more
+// processing power. Rule group capacity is fixed at creation, which helps users
+// plan their web ACL WCU usage when they use a rule group. The WCU limit for
+// web ACLs is 1,500.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -191,14 +190,14 @@ func (c *WAFV2) CheckCapacityRequest(input *CheckCapacityInput) (req *request.Re
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -207,24 +206,23 @@ func (c *WAFV2) CheckCapacityRequest(input *CheckCapacityInput) (req *request.Re
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFInvalidResourceException
-// AWS WAF couldn’t perform the operation because the resource that you requested
+// WAF couldn’t perform the operation because the resource that you requested
// isn’t valid. Check the resource, and try again.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFSubscriptionNotFoundException
// You tried to use a managed rule group that's available by subscription, but
@@ -298,8 +296,8 @@ func (c *WAFV2) CreateIPSetRequest(input *CreateIPSetInput) (req *request.Reques
//
// Creates an IPSet, which you use to identify web requests that originate from
// specific IP addresses or ranges of IP addresses. For example, if you're receiving
-// a lot of requests from a ranges of IP addresses, you can configure AWS WAF
-// to block them using an IPSet that lists those IP addresses.
+// a lot of requests from a ranges of IP addresses, you can configure WAF to
+// block them using an IPSet that lists those IP addresses.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -310,14 +308,14 @@ func (c *WAFV2) CreateIPSetRequest(input *CreateIPSetInput) (req *request.Reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -326,30 +324,29 @@ func (c *WAFV2) CreateIPSetRequest(input *CreateIPSetInput) (req *request.Reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -421,7 +418,7 @@ func (c *WAFV2) CreateRegexPatternSetRequest(input *CreateRegexPatternSetInput)
// CreateRegexPatternSet API operation for AWS WAFV2.
//
// Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement,
-// to have AWS WAF inspect a web request component for the specified patterns.
+// to have WAF inspect a web request component for the specified patterns.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -432,14 +429,14 @@ func (c *WAFV2) CreateRegexPatternSetRequest(input *CreateRegexPatternSetInput)
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -448,30 +445,29 @@ func (c *WAFV2) CreateRegexPatternSetRequest(input *CreateRegexPatternSetInput)
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -559,14 +555,14 @@ func (c *WAFV2) CreateRuleGroupRequest(input *CreateRuleGroupInput) (req *reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -575,41 +571,39 @@ func (c *WAFV2) CreateRuleGroupRequest(input *CreateRuleGroupInput) (req *reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFSubscriptionNotFoundException
// You tried to use a managed rule group that's available by subscription, but
// you aren't subscribed to it yet.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -682,15 +676,15 @@ func (c *WAFV2) CreateWebACLRequest(input *CreateWebACLInput) (req *request.Requ
//
// Creates a WebACL per the specifications provided.
//
-// A Web ACL defines a collection of rules to use to inspect and control web
+// A web ACL defines a collection of rules to use to inspect and control web
// requests. Each rule has an action defined (allow, block, or count) for requests
-// that match the statement of the rule. In the Web ACL, you assign a default
+// that match the statement of the rule. In the web ACL, you assign a default
// action to take (allow, block) for any request that does not match any of
-// the rules. The rules in a Web ACL can be a combination of the types Rule,
-// RuleGroup, and managed rule group. You can associate a Web ACL with one or
-// more AWS resources to protect. The resources can be Amazon CloudFront, an
-// Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync
-// GraphQL API.
+// the rules. The rules in a web ACL can be a combination of the types Rule,
+// RuleGroup, and managed rule group. You can associate a web ACL with one or
+// more Amazon Web Services resources to protect. The resources can be an Amazon
+// CloudFront distribution, an Amazon API Gateway REST API, an Application Load
+// Balancer, or an AppSync GraphQL API.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -701,14 +695,14 @@ func (c *WAFV2) CreateWebACLRequest(input *CreateWebACLInput) (req *request.Requ
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -717,41 +711,39 @@ func (c *WAFV2) CreateWebACLRequest(input *CreateWebACLInput) (req *request.Requ
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFInvalidResourceException
-// AWS WAF couldn’t perform the operation because the resource that you requested
+// WAF couldn’t perform the operation because the resource that you requested
// isn’t valid. Check the resource, and try again.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFSubscriptionNotFoundException
// You tried to use a managed rule group that's available by subscription, but
@@ -826,8 +818,8 @@ func (c *WAFV2) DeleteFirewallManagerRuleGroupsRequest(input *DeleteFirewallMana
// DeleteFirewallManagerRuleGroups API operation for AWS WAFV2.
//
-// Deletes all rule groups that are managed by AWS Firewall Manager for the
-// specified web ACL.
+// Deletes all rule groups that are managed by Firewall Manager for the specified
+// web ACL.
//
// You can only use this if ManagedByFirewallManager is false in the specified
// WebACL.
@@ -841,14 +833,14 @@ func (c *WAFV2) DeleteFirewallManagerRuleGroupsRequest(input *DeleteFirewallMana
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -857,17 +849,15 @@ func (c *WAFV2) DeleteFirewallManagerRuleGroupsRequest(input *DeleteFirewallMana
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -950,14 +940,14 @@ func (c *WAFV2) DeleteIPSetRequest(input *DeleteIPSetInput) (req *request.Reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -966,28 +956,26 @@ func (c *WAFV2) DeleteIPSetRequest(input *DeleteIPSetInput) (req *request.Reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFAssociatedItemException
-// AWS WAF couldn’t perform the operation because your resource is being used
+// WAF couldn’t perform the operation because your resource is being used
// by another resource or it’s associated with another resource.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1070,24 +1058,22 @@ func (c *WAFV2) DeleteLoggingConfigurationRequest(input *DeleteLoggingConfigurat
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1096,7 +1082,7 @@ func (c *WAFV2) DeleteLoggingConfigurationRequest(input *DeleteLoggingConfigurat
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1181,18 +1167,17 @@ func (c *WAFV2) DeletePermissionPolicyRequest(input *DeletePermissionPolicyInput
//
// Returned Error Types:
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1201,7 +1186,7 @@ func (c *WAFV2) DeletePermissionPolicyRequest(input *DeletePermissionPolicyInput
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/DeletePermissionPolicy
func (c *WAFV2) DeletePermissionPolicy(input *DeletePermissionPolicyInput) (*DeletePermissionPolicyOutput, error) {
@@ -1281,14 +1266,14 @@ func (c *WAFV2) DeleteRegexPatternSetRequest(input *DeleteRegexPatternSetInput)
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1297,28 +1282,26 @@ func (c *WAFV2) DeleteRegexPatternSetRequest(input *DeleteRegexPatternSetInput)
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFAssociatedItemException
-// AWS WAF couldn’t perform the operation because your resource is being used
+// WAF couldn’t perform the operation because your resource is being used
// by another resource or it’s associated with another resource.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1401,14 +1384,14 @@ func (c *WAFV2) DeleteRuleGroupRequest(input *DeleteRuleGroupInput) (req *reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1417,28 +1400,26 @@ func (c *WAFV2) DeleteRuleGroupRequest(input *DeleteRuleGroupInput) (req *reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFAssociatedItemException
-// AWS WAF couldn’t perform the operation because your resource is being used
+// WAF couldn’t perform the operation because your resource is being used
// by another resource or it’s associated with another resource.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1524,14 +1505,14 @@ func (c *WAFV2) DeleteWebACLRequest(input *DeleteWebACLInput) (req *request.Requ
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1540,28 +1521,26 @@ func (c *WAFV2) DeleteWebACLRequest(input *DeleteWebACLInput) (req *request.Requ
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFAssociatedItemException
-// AWS WAF couldn’t perform the operation because your resource is being used
+// WAF couldn’t perform the operation because your resource is being used
// by another resource or it’s associated with another resource.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1644,14 +1623,14 @@ func (c *WAFV2) DescribeManagedRuleGroupRequest(input *DescribeManagedRuleGroupI
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1660,15 +1639,14 @@ func (c *WAFV2) DescribeManagedRuleGroupRequest(input *DescribeManagedRuleGroupI
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidResourceException
-// AWS WAF couldn’t perform the operation because the resource that you requested
+// WAF couldn’t perform the operation because the resource that you requested
// isn’t valid. Check the resource, and try again.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1740,13 +1718,13 @@ func (c *WAFV2) DisassociateWebACLRequest(input *DisassociateWebACLInput) (req *
// DisassociateWebACL API operation for AWS WAFV2.
//
-// Disassociates a Web ACL from a regional application resource. A regional
-// application can be an Application Load Balancer (ALB), an API Gateway REST
-// API, or an AppSync GraphQL API.
+// Disassociates a web ACL from a regional application resource. A regional
+// application can be an Application Load Balancer (ALB), an Amazon API Gateway
+// REST API, or an AppSync GraphQL API.
//
-// For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution
-// configuration. To disassociate a Web ACL, provide an empty web ACL ID in
-// the CloudFront call UpdateDistribution. For information, see UpdateDistribution
+// For Amazon CloudFront, don't use this call. Instead, use your CloudFront
+// distribution configuration. To disassociate a web ACL, provide an empty web
+// ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution
// (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
@@ -1758,14 +1736,14 @@ func (c *WAFV2) DisassociateWebACLRequest(input *DisassociateWebACLInput) (req *
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1774,11 +1752,10 @@ func (c *WAFV2) DisassociateWebACLRequest(input *DisassociateWebACLInput) (req *
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1860,14 +1837,14 @@ func (c *WAFV2) GetIPSetRequest(input *GetIPSetInput) (req *request.Request, out
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1876,11 +1853,10 @@ func (c *WAFV2) GetIPSetRequest(input *GetIPSetInput) (req *request.Request, out
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -1962,18 +1938,17 @@ func (c *WAFV2) GetLoggingConfigurationRequest(input *GetLoggingConfigurationInp
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -1982,7 +1957,7 @@ func (c *WAFV2) GetLoggingConfigurationRequest(input *GetLoggingConfigurationInp
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2066,18 +2041,17 @@ func (c *WAFV2) GetPermissionPolicyRequest(input *GetPermissionPolicyInput) (req
//
// Returned Error Types:
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2086,7 +2060,7 @@ func (c *WAFV2) GetPermissionPolicyRequest(input *GetPermissionPolicyInput) (req
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetPermissionPolicy
func (c *WAFV2) GetPermissionPolicy(input *GetPermissionPolicyInput) (*GetPermissionPolicyOutput, error) {
@@ -2168,14 +2142,14 @@ func (c *WAFV2) GetRateBasedStatementManagedKeysRequest(input *GetRateBasedState
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2184,11 +2158,10 @@ func (c *WAFV2) GetRateBasedStatementManagedKeysRequest(input *GetRateBasedState
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2270,14 +2243,14 @@ func (c *WAFV2) GetRegexPatternSetRequest(input *GetRegexPatternSetInput) (req *
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2286,11 +2259,10 @@ func (c *WAFV2) GetRegexPatternSetRequest(input *GetRegexPatternSetInput) (req *
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2372,14 +2344,14 @@ func (c *WAFV2) GetRuleGroupRequest(input *GetRuleGroupInput) (req *request.Requ
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2388,11 +2360,10 @@ func (c *WAFV2) GetRuleGroupRequest(input *GetRuleGroupInput) (req *request.Requ
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2464,16 +2435,16 @@ func (c *WAFV2) GetSampledRequestsRequest(input *GetSampledRequestsInput) (req *
// GetSampledRequests API operation for AWS WAFV2.
//
// Gets detailed information about a specified number of requests--a sample--that
-// AWS WAF randomly selects from among the first 5,000 requests that your AWS
-// resource received during a time range that you choose. You can specify a
-// sample size of up to 500 requests, and you can specify any time range in
-// the previous three hours.
+// WAF randomly selects from among the first 5,000 requests that your Amazon
+// Web Services resource received during a time range that you choose. You can
+// specify a sample size of up to 500 requests, and you can specify any time
+// range in the previous three hours.
//
// GetSampledRequests returns a time range, which is usually the time range
// that you specified. However, if your resource (such as a CloudFront distribution)
// received 5,000 requests before the specified time range elapsed, GetSampledRequests
// returns an updated time range. This new time range indicates the actual period
-// during which AWS WAF selected the requests in the sample.
+// during which WAF selected the requests in the sample.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2484,18 +2455,17 @@ func (c *WAFV2) GetSampledRequestsRequest(input *GetSampledRequestsInput) (req *
//
// Returned Error Types:
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2504,7 +2474,7 @@ func (c *WAFV2) GetSampledRequestsRequest(input *GetSampledRequestsInput) (req *
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/GetSampledRequests
func (c *WAFV2) GetSampledRequests(input *GetSampledRequestsInput) (*GetSampledRequestsOutput, error) {
@@ -2583,14 +2553,14 @@ func (c *WAFV2) GetWebACLRequest(input *GetWebACLInput) (req *request.Request, o
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2599,11 +2569,10 @@ func (c *WAFV2) GetWebACLRequest(input *GetWebACLInput) (req *request.Request, o
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2685,18 +2654,17 @@ func (c *WAFV2) GetWebACLForResourceRequest(input *GetWebACLForResourceInput) (r
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2705,10 +2673,10 @@ func (c *WAFV2) GetWebACLForResourceRequest(input *GetWebACLForResourceInput) (r
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2780,8 +2748,8 @@ func (c *WAFV2) ListAvailableManagedRuleGroupsRequest(input *ListAvailableManage
// ListAvailableManagedRuleGroups API operation for AWS WAFV2.
//
// Retrieves an array of managed rule groups that are available for you to use.
-// This list includes all AWS Managed Rules rule groups and the AWS Marketplace
-// managed rule groups that you're subscribed to.
+// This list includes all Amazon Web Services Managed Rules rule groups and
+// the Marketplace managed rule groups that you're subscribed to.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -2792,14 +2760,14 @@ func (c *WAFV2) ListAvailableManagedRuleGroupsRequest(input *ListAvailableManage
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2808,7 +2776,7 @@ func (c *WAFV2) ListAvailableManagedRuleGroupsRequest(input *ListAvailableManage
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2890,14 +2858,14 @@ func (c *WAFV2) ListIPSetsRequest(input *ListIPSetsInput) (req *request.Request,
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -2906,7 +2874,7 @@ func (c *WAFV2) ListIPSetsRequest(input *ListIPSetsInput) (req *request.Request,
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -2988,14 +2956,14 @@ func (c *WAFV2) ListLoggingConfigurationsRequest(input *ListLoggingConfiguration
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3004,7 +2972,7 @@ func (c *WAFV2) ListLoggingConfigurationsRequest(input *ListLoggingConfiguration
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3087,14 +3055,14 @@ func (c *WAFV2) ListRegexPatternSetsRequest(input *ListRegexPatternSetsInput) (r
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3103,7 +3071,7 @@ func (c *WAFV2) ListRegexPatternSetsRequest(input *ListRegexPatternSetsInput) (r
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3175,8 +3143,8 @@ func (c *WAFV2) ListResourcesForWebACLRequest(input *ListResourcesForWebACLInput
// ListResourcesForWebACL API operation for AWS WAFV2.
//
// Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources
-// that are associated with the specified web ACL. If you want the list of AWS
-// CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.
+// that are associated with the specified web ACL. If you want the list of Amazon
+// CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3187,18 +3155,17 @@ func (c *WAFV2) ListResourcesForWebACLRequest(input *ListResourcesForWebACLInput
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3207,7 +3174,7 @@ func (c *WAFV2) ListResourcesForWebACLRequest(input *ListResourcesForWebACLInput
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3290,14 +3257,14 @@ func (c *WAFV2) ListRuleGroupsRequest(input *ListRuleGroupsInput) (req *request.
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3306,7 +3273,7 @@ func (c *WAFV2) ListRuleGroupsRequest(input *ListRuleGroupsInput) (req *request.
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3381,11 +3348,11 @@ func (c *WAFV2) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req
// pairs that you can use to categorize and manage your resources, for purposes
// like billing. For example, you might set the tag key to "customer" and the
// value to the customer name or ID. You can specify one or more tags to add
-// to each AWS resource, up to 50 tags for a resource.
+// to each Amazon Web Services resource, up to 50 tags for a resource.
//
-// You can tag the AWS resources that you manage through AWS WAF: web ACLs,
-// rule groups, IP sets, and regex pattern sets. You can't manage or view tags
-// through the AWS WAF console.
+// You can tag the Amazon Web Services resources that you manage through WAF:
+// web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage
+// or view tags through the WAF console.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3396,14 +3363,14 @@ func (c *WAFV2) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3412,18 +3379,17 @@ func (c *WAFV2) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3505,14 +3471,14 @@ func (c *WAFV2) ListWebACLsRequest(input *ListWebACLsInput) (req *request.Reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3521,7 +3487,7 @@ func (c *WAFV2) ListWebACLsRequest(input *ListWebACLsInput) (req *request.Reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3595,8 +3561,8 @@ func (c *WAFV2) PutLoggingConfigurationRequest(input *PutLoggingConfigurationInp
// Enables the specified LoggingConfiguration, to start logging from a web ACL,
// according to the configuration provided.
//
-// You can access information about all traffic that AWS WAF inspects using
-// the following steps:
+// You can access information about all traffic that WAF inspects using the
+// following steps:
//
// Create an Amazon Kinesis Data Firehose.
//
@@ -3612,10 +3578,16 @@ func (c *WAFV2) PutLoggingConfigurationRequest(input *PutLoggingConfigurationInp
// Associate that firehose to your web ACL using a PutLoggingConfiguration request.
//
// When you successfully enable logging using a PutLoggingConfiguration request,
-// AWS WAF will create a service linked role with the necessary permissions
-// to write logs to the Amazon Kinesis Data Firehose. For more information,
-// see Logging Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html)
-// in the AWS WAF Developer Guide.
+// WAF will create a service linked role with the necessary permissions to write
+// logs to the Amazon Kinesis Data Firehose. For more information, see Logging
+// Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html)
+// in the WAF Developer Guide.
+//
+// This operation completely replaces the mutable specifications that you already
+// have for the logging configuration with the ones that you provide to this
+// call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration,
+// update the settings as needed, and then provide the complete logging configuration
+// specification to this call.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3626,34 +3598,32 @@ func (c *WAFV2) PutLoggingConfigurationRequest(input *PutLoggingConfigurationInp
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFServiceLinkedRoleErrorException
-// AWS WAF is not able to access the service linked role. This can be caused
-// by a previous PutLoggingConfiguration request, which can lock the service
-// linked role for about 20 seconds. Please try your request again. The service
-// linked role can also be locked by a previous DeleteServiceLinkedRole request,
-// which can lock the role for 15 minutes or more. If you recently made a call
-// to DeleteServiceLinkedRole, wait at least 15 minutes and try the request
-// again. If you receive this same exception again, you will have to wait additional
+// WAF is not able to access the service linked role. This can be caused by
+// a previous PutLoggingConfiguration request, which can lock the service linked
+// role for about 20 seconds. Please try your request again. The service linked
+// role can also be locked by a previous DeleteServiceLinkedRole request, which
+// can lock the role for 15 minutes or more. If you recently made a call to
+// DeleteServiceLinkedRole, wait at least 15 minutes and try the request again.
+// If you receive this same exception again, you will have to wait additional
// time until the role is unlocked.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3662,16 +3632,16 @@ func (c *WAFV2) PutLoggingConfigurationRequest(input *PutLoggingConfigurationInp
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidOperationException
// The operation isn't valid.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// See also, https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/PutLoggingConfiguration
func (c *WAFV2) PutLoggingConfiguration(input *PutLoggingConfigurationInput) (*PutLoggingConfigurationOutput, error) {
@@ -3750,7 +3720,7 @@ func (c *WAFV2) PutPermissionPolicyRequest(input *PutPermissionPolicyInput) (req
// * You can attach only one policy with each PutPermissionPolicy request.
//
// * The ARN in the request must be a valid WAF RuleGroup ARN and the rule
-// group must exist in the same region.
+// group must exist in the same Region.
//
// * The user making the request must be the owner of the rule group.
//
@@ -3763,18 +3733,17 @@ func (c *WAFV2) PutPermissionPolicyRequest(input *PutPermissionPolicyInput) (req
//
// Returned Error Types:
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3783,7 +3752,7 @@ func (c *WAFV2) PutPermissionPolicyRequest(input *PutPermissionPolicyInput) (req
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFInvalidPermissionPolicyException
// The operation failed because the specified policy isn't in the proper format.
@@ -3798,7 +3767,7 @@ func (c *WAFV2) PutPermissionPolicyRequest(input *PutPermissionPolicyInput) (req
// * Effect must specify Allow.
//
// * Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups.
-// AWS WAF rejects any extra actions or wildcard actions in the policy.
+// WAF rejects any extra actions or wildcard actions in the policy.
//
// * The policy must not include a Resource parameter.
//
@@ -3871,15 +3840,15 @@ func (c *WAFV2) TagResourceRequest(input *TagResourceInput) (req *request.Reques
// TagResource API operation for AWS WAFV2.
//
-// Associates tags with the specified AWS resource. Tags are key:value pairs
-// that you can use to categorize and manage your resources, for purposes like
-// billing. For example, you might set the tag key to "customer" and the value
-// to the customer name or ID. You can specify one or more tags to add to each
-// AWS resource, up to 50 tags for a resource.
+// Associates tags with the specified Amazon Web Services resource. Tags are
+// key:value pairs that you can use to categorize and manage your resources,
+// for purposes like billing. For example, you might set the tag key to "customer"
+// and the value to the customer name or ID. You can specify one or more tags
+// to add to each Amazon Web Services resource, up to 50 tags for a resource.
//
-// You can tag the AWS resources that you manage through AWS WAF: web ACLs,
-// rule groups, IP sets, and regex pattern sets. You can't manage or view tags
-// through the AWS WAF console.
+// You can tag the Amazon Web Services resources that you manage through WAF:
+// web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage
+// or view tags through the WAF console.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -3890,14 +3859,14 @@ func (c *WAFV2) TagResourceRequest(input *TagResourceInput) (req *request.Reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -3906,24 +3875,23 @@ func (c *WAFV2) TagResourceRequest(input *TagResourceInput) (req *request.Reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -3995,10 +3963,11 @@ func (c *WAFV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Re
// UntagResource API operation for AWS WAFV2.
//
-// Disassociates tags from an AWS resource. Tags are key:value pairs that you
-// can associate with AWS resources. For example, the tag key might be "customer"
-// and the tag value might be "companyA." You can specify one or more tags to
-// add to each container. You can add up to 50 tags to each AWS resource.
+// Disassociates tags from an Amazon Web Services resource. Tags are key:value
+// pairs that you can associate with Amazon Web Services resources. For example,
+// the tag key might be "customer" and the tag value might be "companyA." You
+// can specify one or more tags to add to each container. You can add up to
+// 50 tags to each Amazon Web Services resource.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4009,14 +3978,14 @@ func (c *WAFV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Re
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -4025,18 +3994,17 @@ func (c *WAFV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Re
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFTagOperationException
// An error occurred during the tagging operation. Retry your request.
//
// * WAFTagOperationInternalErrorException
-// AWS WAF couldn’t perform your tagging operation because of an internal
-// error. Retry your request.
+// WAF couldn’t perform your tagging operation because of an internal error.
+// Retry your request.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -4109,11 +4077,10 @@ func (c *WAFV2) UpdateIPSetRequest(input *UpdateIPSetInput) (req *request.Reques
//
// Updates the specified IPSet.
//
-// This operation completely replaces any IP address specifications that you
-// already have in the IP set with the ones that you provide to this call. If
-// you want to add to or modify the addresses that are already in the IP set,
-// retrieve those by calling GetIPSet, update them, and provide the complete
-// updated array of IP addresses to this call.
+// This operation completely replaces the mutable specifications that you already
+// have for the IP set with the ones that you provide to this call. To modify
+// the IP set, retrieve it by calling GetIPSet, update the settings as needed,
+// and then provide the complete IP set specification to this call.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4124,14 +4091,14 @@ func (c *WAFV2) UpdateIPSetRequest(input *UpdateIPSetInput) (req *request.Reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -4140,27 +4107,25 @@ func (c *WAFV2) UpdateIPSetRequest(input *UpdateIPSetInput) (req *request.Reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -4233,6 +4198,12 @@ func (c *WAFV2) UpdateRegexPatternSetRequest(input *UpdateRegexPatternSetInput)
//
// Updates the specified RegexPatternSet.
//
+// This operation completely replaces the mutable specifications that you already
+// have for the regex pattern set with the ones that you provide to this call.
+// To modify the regex pattern set, retrieve it by calling GetRegexPatternSet,
+// update the settings as needed, and then provide the complete regex pattern
+// set specification to this call.
+//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
@@ -4242,14 +4213,14 @@ func (c *WAFV2) UpdateRegexPatternSetRequest(input *UpdateRegexPatternSetInput)
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -4258,27 +4229,25 @@ func (c *WAFV2) UpdateRegexPatternSetRequest(input *UpdateRegexPatternSetInput)
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFInvalidOperationException
// The operation isn't valid.
@@ -4351,6 +4320,12 @@ func (c *WAFV2) UpdateRuleGroupRequest(input *UpdateRuleGroupInput) (req *reques
//
// Updates the specified RuleGroup.
//
+// This operation completely replaces the mutable specifications that you already
+// have for the rule group with the ones that you provide to this call. To modify
+// the rule group, retrieve it by calling GetRuleGroup, update the settings
+// as needed, and then provide the complete rule group specification to this
+// call.
+//
// A rule group defines a collection of rules to inspect and control web requests
// that you can use in a WebACL. When you create a rule group, you define an
// immutable capacity limit. If you update a rule group, you must stay within
@@ -4366,14 +4341,14 @@ func (c *WAFV2) UpdateRuleGroupRequest(input *UpdateRuleGroupInput) (req *reques
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -4382,30 +4357,28 @@ func (c *WAFV2) UpdateRuleGroupRequest(input *UpdateRuleGroupInput) (req *reques
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFSubscriptionNotFoundException
// You tried to use a managed rule group that's available by subscription, but
@@ -4482,15 +4455,20 @@ func (c *WAFV2) UpdateWebACLRequest(input *UpdateWebACLInput) (req *request.Requ
//
// Updates the specified WebACL.
//
-// A Web ACL defines a collection of rules to use to inspect and control web
+// This operation completely replaces the mutable specifications that you already
+// have for the web ACL with the ones that you provide to this call. To modify
+// the web ACL, retrieve it by calling GetWebACL, update the settings as needed,
+// and then provide the complete web ACL specification to this call.
+//
+// A web ACL defines a collection of rules to use to inspect and control web
// requests. Each rule has an action defined (allow, block, or count) for requests
-// that match the statement of the rule. In the Web ACL, you assign a default
+// that match the statement of the rule. In the web ACL, you assign a default
// action to take (allow, block) for any request that does not match any of
-// the rules. The rules in a Web ACL can be a combination of the types Rule,
-// RuleGroup, and managed rule group. You can associate a Web ACL with one or
-// more AWS resources to protect. The resources can be Amazon CloudFront, an
-// Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync
-// GraphQL API.
+// the rules. The rules in a web ACL can be a combination of the types Rule,
+// RuleGroup, and managed rule group. You can associate a web ACL with one or
+// more Amazon Web Services resources to protect. The resources can be an Amazon
+// CloudFront distribution, an Amazon API Gateway REST API, an Application Load
+// Balancer, or an AppSync GraphQL API.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
@@ -4501,14 +4479,14 @@ func (c *WAFV2) UpdateWebACLRequest(input *UpdateWebACLInput) (req *request.Requ
//
// Returned Error Types:
// * WAFInternalErrorException
-// Your request is valid, but AWS WAF couldn’t perform the operation because
-// of a system problem. Retry your request.
+// Your request is valid, but WAF couldn’t perform the operation because of
+// a system problem. Retry your request.
//
// * WAFInvalidParameterException
-// The operation failed because AWS WAF didn't recognize a parameter in the
-// request. For example:
+// The operation failed because WAF didn't recognize a parameter in the request.
+// For example:
//
-// * You specified an invalid parameter name or value.
+// * You specified a parameter name or value that isn't valid.
//
// * Your nested statement isn't valid. You might have tried to nest a statement
// that can’t be nested.
@@ -4517,34 +4495,32 @@ func (c *WAFV2) UpdateWebACLRequest(input *UpdateWebACLInput) (req *request.Requ
// types available at DefaultAction.
//
// * Your request references an ARN that is malformed, or corresponds to
-// a resource with which a Web ACL cannot be associated.
+// a resource with which a web ACL can't be associated.
//
// * WAFNonexistentItemException
-// AWS WAF couldn’t perform the operation because your resource doesn’t
-// exist.
+// WAF couldn’t perform the operation because your resource doesn’t exist.
//
// * WAFDuplicateItemException
-// AWS WAF couldn’t perform the operation because the resource that you tried
+// WAF couldn’t perform the operation because the resource that you tried
// to save is a duplicate of an existing one.
//
// * WAFOptimisticLockException
-// AWS WAF couldn’t save your changes because you tried to update or delete
-// a resource that has changed since you last retrieved it. Get the resource
-// again, make any changes you need to make to the new copy, and retry your
-// operation.
+// WAF couldn’t save your changes because you tried to update or delete a
+// resource that has changed since you last retrieved it. Get the resource again,
+// make any changes you need to make to the new copy, and retry your operation.
//
// * WAFLimitsExceededException
-// AWS WAF couldn’t perform the operation because you exceeded your resource
-// limit. For example, the maximum number of WebACL objects that you can create
-// for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
-// in the AWS WAF Developer Guide.
+// WAF couldn’t perform the operation because you exceeded your resource limit.
+// For example, the maximum number of WebACL objects that you can create for
+// an account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+// in the WAF Developer Guide.
//
// * WAFInvalidResourceException
-// AWS WAF couldn’t perform the operation because the resource that you requested
+// WAF couldn’t perform the operation because the resource that you requested
// isn’t valid. Check the resource, and try again.
//
// * WAFUnavailableEntityException
-// AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
+// WAF couldn’t retrieve the resource that you requested. Retry your request.
//
// * WAFSubscriptionNotFoundException
// You tried to use a managed rule group that's available by subscription, but
@@ -4614,11 +4590,11 @@ func (s *ActionCondition) SetAction(v string) *ActionCondition {
return s
}
-// Inspect all of the elements that AWS WAF has parsed and extracted from the
-// web request JSON body that are within the JsonBody MatchScope. This is used
-// with the FieldToMatch option JsonBody.
+// Inspect all of the elements that WAF has parsed and extracted from the web
+// request JSON body that are within the JsonBody MatchScope. This is used with
+// the FieldToMatch option JsonBody.
//
-// This is used only to indicate the web request component for AWS WAF to inspect,
+// This is used only to indicate the web request component for WAF to inspect,
// in the FieldToMatch specification.
type All struct {
_ struct{} `type:"structure"`
@@ -4636,7 +4612,7 @@ func (s All) GoString() string {
// All query arguments of a web request.
//
-// This is used only to indicate the web request component for AWS WAF to inspect,
+// This is used only to indicate the web request component for WAF to inspect,
// in the FieldToMatch specification.
type AllQueryArguments struct {
_ struct{} `type:"structure"`
@@ -4652,7 +4628,7 @@ func (s AllQueryArguments) GoString() string {
return s.String()
}
-// Specifies that AWS WAF should allow the request and optionally defines additional
+// Specifies that WAF should allow the request and optionally defines additional
// custom handling for the request.
//
// This is used in the context of other settings, for example to specify values
@@ -4663,8 +4639,8 @@ type AllowAction struct {
// Defines custom handling for the web request.
//
// For information about customizing web requests and responses, see Customizing
- // web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomRequestHandling *CustomRequestHandling `type:"structure"`
}
@@ -4750,14 +4726,14 @@ type AssociateWebACLInput struct {
//
// * For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
//
- // * For an API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
+ // * For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
//
// * For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId
//
// ResourceArn is a required field
ResourceArn *string `min:"20" type:"string" required:"true"`
- // The Amazon Resource Name (ARN) of the Web ACL that you want to associate
+ // The Amazon Resource Name (ARN) of the web ACL that you want to associate
// with the resource.
//
// WebACLArn is a required field
@@ -4822,7 +4798,7 @@ func (s AssociateWebACLOutput) GoString() string {
return s.String()
}
-// Specifies that AWS WAF should block the request and optionally defines additional
+// Specifies that WAF should block the request and optionally defines additional
// custom handling for the response to the web request.
//
// This is used in the context of other settings, for example to specify values
@@ -4833,8 +4809,8 @@ type BlockAction struct {
// Defines a custom response for the web request.
//
// For information about customizing web requests and responses, see Customizing
- // web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomResponse *CustomResponse `type:"structure"`
}
@@ -4871,7 +4847,7 @@ func (s *BlockAction) SetCustomResponse(v *CustomResponse) *BlockAction {
// The body of a web request. This immediately follows the request headers.
//
-// This is used only to indicate the web request component for AWS WAF to inspect,
+// This is used only to indicate the web request component for WAF to inspect,
// in the FieldToMatch specification.
type Body struct {
_ struct{} `type:"structure"`
@@ -4887,22 +4863,22 @@ func (s Body) GoString() string {
return s.String()
}
-// A rule statement that defines a string match search for AWS WAF to apply
-// to web requests. The byte match statement provides the bytes to search for,
-// the location in requests that you want AWS WAF to search, and other settings.
-// The bytes to search for are typically a string that corresponds with ASCII
-// characters. In the AWS WAF console and the developer guide, this is refered
-// to as a string match statement.
+// A rule statement that defines a string match search for WAF to apply to web
+// requests. The byte match statement provides the bytes to search for, the
+// location in requests that you want WAF to search, and other settings. The
+// bytes to search for are typically a string that corresponds with ASCII characters.
+// In the WAF console and the developer guide, this is refered to as a string
+// match statement.
type ByteMatchStatement struct {
_ struct{} `type:"structure"`
- // The part of a web request that you want AWS WAF to inspect. For more information,
+ // The part of a web request that you want WAF to inspect. For more information,
// see FieldToMatch.
//
// FieldToMatch is a required field
FieldToMatch *FieldToMatch `type:"structure" required:"true"`
- // The area within the portion of a web request that you want AWS WAF to search
+ // The area within the portion of a web request that you want WAF to search
// for SearchString. Valid values include the following:
//
// CONTAINS
@@ -4943,22 +4919,22 @@ type ByteMatchStatement struct {
// PositionalConstraint is a required field
PositionalConstraint *string `type:"string" required:"true" enum:"PositionalConstraint"`
- // A string value that you want AWS WAF to search for. AWS WAF searches only
- // in the part of web requests that you designate for inspection in FieldToMatch.
- // The maximum length of the value is 50 bytes.
+ // A string value that you want WAF to search for. WAF searches only in the
+ // part of web requests that you designate for inspection in FieldToMatch. The
+ // maximum length of the value is 50 bytes.
//
// Valid values depend on the component that you specify for inspection in FieldToMatch:
//
- // * Method: The HTTP method that you want AWS WAF to search for. This indicates
+ // * Method: The HTTP method that you want WAF to search for. This indicates
// the type of operation specified in the request.
//
- // * UriPath: The value that you want AWS WAF to search for in the URI path,
+ // * UriPath: The value that you want WAF to search for in the URI path,
// for example, /images/daily-ad.jpg.
//
// If SearchString includes alphabetic characters A-Z and a-z, note that the
// value is case sensitive.
//
- // If you're using the AWS WAF API
+ // If you're using the WAF API
//
// Specify a base64-encoded version of the value. The maximum length of the
// value before you base64-encode it is 50 bytes.
@@ -4968,10 +4944,10 @@ type ByteMatchStatement struct {
// you base64-encode BadBot using MIME base64-encoding and include the resulting
// value, QmFkQm90, in the value of SearchString.
//
- // If you're using the AWS CLI or one of the AWS SDKs
+ // If you're using the CLI or one of the Amazon Web Services SDKs
//
- // The value that you want AWS WAF to search for. The SDK automatically base64
- // encodes the value.
+ // The value that you want WAF to search for. The SDK automatically base64 encodes
+ // the value.
//
// SearchString is automatically base64 encoded/decoded by the SDK.
//
@@ -4980,7 +4956,7 @@ type ByteMatchStatement struct {
// Text transformations eliminate some of the unusual formatting that attackers
// use in web requests in an effort to bypass detection. If you specify one
- // or more transformations in a rule statement, AWS WAF performs all transformations
+ // or more transformations in a rule statement, WAF performs all transformations
// on the content of the request component identified by FieldToMatch, starting
// from the lowest priority setting, before inspecting the content for a match.
//
@@ -5070,9 +5046,9 @@ type CheckCapacityInput struct {
// Rules is a required field
Rules []*Rule `type:"list" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -5210,7 +5186,7 @@ func (s *Condition) SetLabelNameCondition(v *LabelNameCondition) *Condition {
return s
}
-// Specifies that AWS WAF should count the request. Optionally defines additional
+// Specifies that WAF should count the request. Optionally defines additional
// custom handling for the request.
//
// This is used in the context of other settings, for example to specify values
@@ -5221,8 +5197,8 @@ type CountAction struct {
// Defines custom handling for the web request.
//
// For information about customizing web requests and responses, see Customizing
- // web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomRequestHandling *CustomRequestHandling `type:"structure"`
}
@@ -5261,21 +5237,21 @@ type CreateIPSetInput struct {
_ struct{} `type:"structure"`
// Contains an array of strings that specify one or more IP addresses or blocks
- // of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF
- // supports all IPv4 and IPv6 CIDR ranges except for /0.
+ // of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports
+ // all IPv4 and IPv6 CIDR ranges except for /0.
//
// Examples:
//
- // * To configure AWS WAF to allow, block, or count requests that originated
+ // * To configure WAF to allow, block, or count requests that originated
// from the IP address 192.0.2.44, specify 192.0.2.44/32.
//
- // * To configure AWS WAF to allow, block, or count requests that originated
+ // * To configure WAF to allow, block, or count requests that originated
// from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
//
- // * To configure AWS WAF to allow, block, or count requests that originated
+ // * To configure WAF to allow, block, or count requests that originated
// from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
//
- // * To configure AWS WAF to allow, block, or count requests that originated
+ // * To configure WAF to allow, block, or count requests that originated
// from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff,
// specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
//
@@ -5299,9 +5275,9 @@ type CreateIPSetInput struct {
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -5447,9 +5423,9 @@ type CreateRegexPatternSetInput struct {
// RegularExpressionList is a required field
RegularExpressionList []*Regex `type:"list" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -5586,17 +5562,17 @@ type CreateRuleGroupInput struct {
// The web ACL capacity units (WCUs) required for this rule group.
//
// When you create your own rule group, you define this, and you cannot change
- // it after creation. When you add or modify the rules in a rule group, AWS
- // WAF enforces this limit. You can check the capacity for a set of rules using
+ // it after creation. When you add or modify the rules in a rule group, WAF
+ // enforces this limit. You can check the capacity for a set of rules using
// CheckCapacity.
//
- // AWS WAF uses WCUs to calculate and control the operating resources that are
- // used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity
- // differently for each rule type, to reflect the relative cost of each rule.
- // Simple rules that cost little to run use fewer WCUs than more complex rules
- // that use more processing power. Rule group capacity is fixed at creation,
- // which helps users plan their web ACL WCU usage when they use a rule group.
- // The WCU limit for web ACLs is 1,500.
+ // WAF uses WCUs to calculate and control the operating resources that are used
+ // to run your rules, rule groups, and web ACLs. WAF calculates capacity differently
+ // for each rule type, to reflect the relative cost of each rule. Simple rules
+ // that cost little to run use fewer WCUs than more complex rules that use more
+ // processing power. Rule group capacity is fixed at creation, which helps users
+ // plan their web ACL WCU usage when they use a rule group. The WCU limit for
+ // web ACLs is 1,500.
//
// Capacity is a required field
Capacity *int64 `min:"1" type:"long" required:"true"`
@@ -5607,12 +5583,12 @@ type CreateRuleGroupInput struct {
// define in the rule group.
//
// For information about customizing web requests and responses, see Customizing
- // web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// For information about the limits on count and size for custom request and
- // response settings, see AWS WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomResponseBodies map[string]*CustomResponseBody `min:"1" type:"map"`
// A description of the rule group that helps with identification.
@@ -5625,14 +5601,14 @@ type CreateRuleGroupInput struct {
Name *string `min:"1" type:"string" required:"true"`
// The Rule statements used to identify the web requests that you want to allow,
- // block, or count. Each rule includes one top-level statement that AWS WAF
- // uses to identify matching web requests, and parameters that govern how AWS
- // WAF handles them.
+ // block, or count. Each rule includes one top-level statement that WAF uses
+ // to identify matching web requests, and parameters that govern how WAF handles
+ // them.
Rules []*Rule `type:"list"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -5819,12 +5795,12 @@ type CreateWebACLInput struct {
// actions that you define in the web ACL.
//
// For information about customizing web requests and responses, see Customizing
- // web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// For information about the limits on count and size for custom request and
- // response settings, see AWS WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomResponseBodies map[string]*CustomResponseBody `min:"1" type:"map"`
// The action to perform if none of the Rules contained in the WebACL match.
@@ -5832,24 +5808,24 @@ type CreateWebACLInput struct {
// DefaultAction is a required field
DefaultAction *DefaultAction `type:"structure" required:"true"`
- // A description of the Web ACL that helps with identification.
+ // A description of the web ACL that helps with identification.
Description *string `min:"1" type:"string"`
- // The name of the Web ACL. You cannot change the name of a Web ACL after you
+ // The name of the web ACL. You cannot change the name of a web ACL after you
// create it.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
// The Rule statements used to identify the web requests that you want to allow,
- // block, or count. Each rule includes one top-level statement that AWS WAF
- // uses to identify matching web requests, and parameters that govern how AWS
- // WAF handles them.
+ // block, or count. Each rule includes one top-level statement that WAF uses
+ // to identify matching web requests, and parameters that govern how WAF handles
+ // them.
Rules []*Rule `type:"list"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -6035,10 +6011,10 @@ type CustomHTTPHeader struct {
// The name of the custom header.
//
- // For custom request header insertion, when AWS WAF inserts the header into
- // the request, it prefixes this name x-amzn-waf-, to avoid confusion with the
- // headers that are already in the request. For example, for the header name
- // sample, AWS WAF inserts the header x-amzn-waf-sample.
+ // For custom request header insertion, when WAF inserts the header into the
+ // request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers
+ // that are already in the request. For example, for the header name sample,
+ // WAF inserts the header x-amzn-waf-sample.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
@@ -6097,8 +6073,8 @@ func (s *CustomHTTPHeader) SetValue(v string) *CustomHTTPHeader {
// You can add custom request handling for the rule actions allow and count.
//
// For information about customizing web requests and responses, see Customizing
-// web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
-// in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+// web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+// in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
type CustomRequestHandling struct {
_ struct{} `type:"structure"`
@@ -6106,8 +6082,8 @@ type CustomRequestHandling struct {
// allowed.
//
// For information about the limits on count and size for custom request and
- // response settings, see AWS WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// InsertHeaders is a required field
InsertHeaders []*CustomHTTPHeader `min:"1" type:"list" required:"true"`
@@ -6159,12 +6135,12 @@ func (s *CustomRequestHandling) SetInsertHeaders(v []*CustomHTTPHeader) *CustomR
// for rule actions and default web ACL actions that are set to BlockAction.
//
// For information about customizing web requests and responses, see Customizing
-// web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
-// in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+// web requests and responses in WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
+// in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
type CustomResponse struct {
_ struct{} `type:"structure"`
- // References the response body that you want AWS WAF to return to the web request
+ // References the response body that you want WAF to return to the web request
// client. You can define a custom response for a rule action or a default web
// ACL action that is set to block. To do this, you first define the response
// body key and value in the CustomResponseBodies setting for the WebACL or
@@ -6176,7 +6152,7 @@ type CustomResponse struct {
//
// For a list of status codes that you can use in your custom reqponses, see
// Supported status codes for custom response (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// ResponseCode is a required field
ResponseCode *int64 `min:"200" type:"integer" required:"true"`
@@ -6184,8 +6160,8 @@ type CustomResponse struct {
// The HTTP headers to use in the response. Duplicate header names are not allowed.
//
// For information about the limits on count and size for custom request and
- // response settings, see AWS WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
ResponseHeaders []*CustomHTTPHeader `min:"1" type:"list"`
}
@@ -6260,8 +6236,8 @@ type CustomResponseBody struct {
// JSON content in the ContentType setting.
//
// For information about the limits on count and size for custom request and
- // response settings, see AWS WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
- // in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
+ // response settings, see WAF quotas (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html)
+ // in the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// Content is a required field
Content *string `min:"1" type:"string" required:"true"`
@@ -6313,16 +6289,16 @@ func (s *CustomResponseBody) SetContentType(v string) *CustomResponseBody {
return s
}
-// In a WebACL, this is the action that you want AWS WAF to perform when a web
-// request doesn't match any of the rules in the WebACL. The default action
-// must be a terminating action, so you can't use count.
+// In a WebACL, this is the action that you want WAF to perform when a web request
+// doesn't match any of the rules in the WebACL. The default action must be
+// a terminating action, so you can't use count.
type DefaultAction struct {
_ struct{} `type:"structure"`
- // Specifies that AWS WAF should allow requests by default.
+ // Specifies that WAF should allow requests by default.
Allow *AllowAction `type:"structure"`
- // Specifies that AWS WAF should block requests by default.
+ // Specifies that WAF should block requests by default.
Block *BlockAction `type:"structure"`
}
@@ -6376,10 +6352,10 @@ type DeleteFirewallManagerRuleGroupsInput struct {
// WebACLArn is a required field
WebACLArn *string `min:"20" type:"string" required:"true"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6436,10 +6412,10 @@ func (s *DeleteFirewallManagerRuleGroupsInput) SetWebACLLockToken(v string) *Del
type DeleteFirewallManagerRuleGroupsOutput struct {
_ struct{} `type:"structure"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6472,10 +6448,10 @@ type DeleteIPSetInput struct {
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6490,9 +6466,9 @@ type DeleteIPSetInput struct {
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -6708,10 +6684,10 @@ type DeleteRegexPatternSetInput struct {
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6725,9 +6701,9 @@ type DeleteRegexPatternSetInput struct {
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -6830,10 +6806,10 @@ type DeleteRuleGroupInput struct {
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6848,9 +6824,9 @@ type DeleteRuleGroupInput struct {
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -6946,17 +6922,17 @@ func (s DeleteRuleGroupOutput) GoString() string {
type DeleteWebACLInput struct {
_ struct{} `type:"structure"`
- // The unique identifier for the Web ACL. This ID is returned in the responses
+ // The unique identifier for the web ACL. This ID is returned in the responses
// to create and list commands. You provide it to operations like update and
// delete.
//
// Id is a required field
Id *string `min:"1" type:"string" required:"true"`
- // A token used for optimistic locking. AWS WAF returns a token to your get
- // and list requests, to mark the state of the entity at the time of the request.
+ // A token used for optimistic locking. WAF returns a token to your get and
+ // list requests, to mark the state of the entity at the time of the request.
// To make changes to the entity associated with the token, you provide the
- // token to operations like update and delete. AWS WAF uses the token to ensure
+ // token to operations like update and delete. WAF uses the token to ensure
// that no changes have been made to the entity since you last retrieved it.
// If a change has been made, the update fails with a WAFOptimisticLockException.
// If this happens, perform another get, and use the new token returned by that
@@ -6965,15 +6941,15 @@ type DeleteWebACLInput struct {
// LockToken is a required field
LockToken *string `min:"1" type:"string" required:"true"`
- // The name of the Web ACL. You cannot change the name of a Web ACL after you
+ // The name of the web ACL. You cannot change the name of a web ACL after you
// create it.
//
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -7075,9 +7051,9 @@ type DescribeManagedRuleGroupInput struct {
// Name is a required field
Name *string `min:"1" type:"string" required:"true"`
- // Specifies whether this is for an AWS CloudFront distribution or for a regional
- // application. A regional application can be an Application Load Balancer (ALB),
- // an API Gateway REST API, or an AppSync GraphQL API.
+ // Specifies whether this is for an Amazon CloudFront distribution or for a
+ // regional application. A regional application can be an Application Load Balancer
+ // (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
//
// To work with CloudFront, you must also specify the Region US East (N. Virginia)
// as follows:
@@ -7154,12 +7130,12 @@ type DescribeManagedRuleGroupOutput struct {
_ struct{} `type:"structure"`
// The labels that one or more rules in this rule group add to matching web
- // ACLs. These labels are defined in the RuleLabels for a Rule.
+ // requests. These labels are defined in the RuleLabels for a Rule.
AvailableLabels []*LabelSummary `type:"list"`
- // The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses
+ // The web ACL capacity units (WCUs) required for this rule group. WAF uses
// web ACL capacity units (WCU) to calculate and control the operating resources
- // that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates
+ // that are used to run your rules, rule groups, and web ACLs. WAF calculates
// capacity differently for each rule type, to reflect each rule's relative
// cost. Rule group capacity is fixed at creation, so users can plan their web
// ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
@@ -7176,10 +7152,10 @@ type DescribeManagedRuleGroupOutput struct {
// * The syntax for the label namespace prefix for a managed rule group is
// the following: awswaf:managed:::
//
- // * When a rule with a label matches a web request, AWS WAF adds the fully
- // qualified label to the request. A fully qualified label is made up of
- // the label namespace from the rule group or web ACL where the rule is defined
- // and the label from the rule, separated by a colon: