software.amazon.awssdk.services.ram.model

Interface AssociateResourceShareRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AssociateResourceShareRequest.Builder,AssociateResourceShareRequest>, RamRequest.Builder, SdkBuilder<AssociateResourceShareRequest.Builder,AssociateResourceShareRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AssociateResourceShareRequest

public static interface AssociateResourceShareRequest.Builder
extends RamRequest.Builder, SdkPojo, CopyableBuilder<AssociateResourceShareRequest.Builder,AssociateResourceShareRequest>

Method Summary

Modifier and Type	Method and Description
AssociateResourceShareRequest.Builder	clientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AssociateResourceShareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AssociateResourceShareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AssociateResourceShareRequest.Builder	principals(Collection<String> principals) Specifies a list of principals to whom you want to the resource share.
AssociateResourceShareRequest.Builder	principals(String... principals) Specifies a list of principals to whom you want to the resource share.
AssociateResourceShareRequest.Builder	resourceArns(Collection<String> resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
AssociateResourceShareRequest.Builder	resourceArns(String... resourceArns) Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share.
AssociateResourceShareRequest.Builder	resourceShareArn(String resourceShareArn) Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
AssociateResourceShareRequest.Builder	sources(Collection<String> sources) Specifies from which source accounts the service principal has access to the resources in this resource share.
AssociateResourceShareRequest.Builder	sources(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.services.ram.model.RamRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

resourceShareArn

AssociateResourceShareRequest.Builder resourceShareArn(String resourceShareArn)

Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Parameters:

resourceShareArn - Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceArns

AssociateResourceShareRequest.Builder resourceArns(Collection<String> 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 be null if you want to add only principals.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceArns

AssociateResourceShareRequest.Builder resourceArns(String... 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 be null if you want to add only principals.

Returns:

Returns a reference to this object so that method calls can be chained together.

principals

AssociateResourceShareRequest.Builder principals(Collection<String> 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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

principals

AssociateResourceShareRequest.Builder principals(String... 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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

AssociateResourceShareRequest.Builder clientToken(String 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 an IdempotentParameterMismatch 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 an IdempotentParameterMismatch error.

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

AssociateResourceShareRequest.Builder sources(Collection<String> 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

AssociateResourceShareRequest.Builder sources(String... 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AssociateResourceShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder