Interface CreateAccessGrantsLocationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAccessGrantsLocationRequest.Builder,
,CreateAccessGrantsLocationRequest> S3ControlRequest.Builder
,SdkBuilder<CreateAccessGrantsLocationRequest.Builder,
,CreateAccessGrantsLocationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAccessGrantsLocationRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Web Services account ID of the S3 Access Grants instance.iamRoleArn
(String iamRoleArn) The Amazon Resource Name (ARN) of the IAM role for the registered location.locationScope
(String locationScope) The S3 path to the location that you are registering.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) The Amazon Web Services resource tags that you are adding to the S3 Access Grants location.tags
(Consumer<Tag.Builder>... tags) The Amazon Web Services resource tags that you are adding to the S3 Access Grants location.The Amazon Web Services resource tags that you are adding to the S3 Access Grants location.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
accountId
The Amazon Web Services account ID of the S3 Access Grants instance.
- Parameters:
accountId
- The Amazon Web Services account ID of the S3 Access Grants instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locationScope
The S3 path to the location that you are registering. The location scope can be the default S3 location
s3://
, the S3 path to a buckets3://<bucket>
, or the S3 path to a bucket and prefixs3://<bucket>/<prefix>
. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with theengineering/
prefix or object key names that start with themarketing/campaigns/
prefix.- Parameters:
locationScope
- The S3 path to the location that you are registering. The location scope can be the default S3 locations3://
, the S3 path to a buckets3://<bucket>
, or the S3 path to a bucket and prefixs3://<bucket>/<prefix>
. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with theengineering/
prefix or object key names that start with themarketing/campaigns/
prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoleArn
The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.
- Parameters:
iamRoleArn
- The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Parameters:
tags
- The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
- Parameters:
tags
- The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateAccessGrantsLocationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateAccessGrantsLocationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-