Interface AssociateResourceShareRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AssociateResourceShareRequest.Builder,
,AssociateResourceShareRequest> RamRequest.Builder
,SdkBuilder<AssociateResourceShareRequest.Builder,
,AssociateResourceShareRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AssociateResourceShareRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.principals
(String... principals) Specifies a list of principals to whom you want to the resource share.principals
(Collection<String> principals) Specifies a list of principals to whom you want to the resource share.resourceArns
(String... resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.resourceArns
(Collection<String> resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.resourceShareArn
(String resourceShareArn) Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.Specifies from which source accounts the service principal has access to the resources in this resource share.sources
(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.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.ram.model.RamRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
resourceArns
Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be
null
if you want to add only principals.- Parameters:
resourceArns
- Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can benull
if you want to add only principals.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceArns
Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be
null
if you want to add only principals.- Parameters:
resourceArns
- Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can benull
if you want to add only principals.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
principals
Specifies a list of principals to whom you want to the resource share. This can be
null
if you want to add only resources.What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
-
An Amazon Web Services account ID, for example:
123456789012
-
An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
- Parameters:
principals
- Specifies a list of principals to whom you want to the resource share. This can benull
if you want to add only resources.What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
-
An Amazon Web Services account ID, for example:
123456789012
-
An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
principals
Specifies a list of principals to whom you want to the resource share. This can be
null
if you want to add only resources.What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
-
An Amazon Web Services account ID, for example:
123456789012
-
An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
- Parameters:
principals
- Specifies a list of principals to whom you want to the resource share. This can benull
if you want to add only resources.What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
-
An Amazon Web Services account ID, for example:
123456789012
-
An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.- Parameters:
clientToken
- Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sources
Specifies from which source accounts the service principal has access to the resources in this resource share.
- Parameters:
sources
- Specifies from which source accounts the service principal has access to the resources in this resource share.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sources
Specifies from which source accounts the service principal has access to the resources in this resource share.
- Parameters:
sources
- Specifies from which source accounts the service principal has access to the resources in this resource share.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AssociateResourceShareRequest.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
AssociateResourceShareRequest.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.