software.amazon.awssdk.services.ram.model

Interface AssociateResourceSharePermissionRequest.Builder

All Superinterfaces:

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

Enclosing class:

AssociateResourceSharePermissionRequest

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

Method Summary

Modifier and Type	Method and Description
AssociateResourceSharePermissionRequest.Builder	clientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AssociateResourceSharePermissionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AssociateResourceSharePermissionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AssociateResourceSharePermissionRequest.Builder	permissionArn(String permissionArn) Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.
AssociateResourceSharePermissionRequest.Builder	permissionVersion(Integer permissionVersion) Specifies the version of the RAM permission to associate with the resource share.
AssociateResourceSharePermissionRequest.Builder	replace(Boolean replace) Specifies whether the specified permission should replace the existing permission associated with the resource share.
AssociateResourceSharePermissionRequest.Builder	resourceShareArn(String resourceShareArn) Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.

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

AssociateResourceSharePermissionRequest.Builder resourceShareArn(String resourceShareArn)

Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.

Parameters:

resourceShareArn - Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.

Returns:

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

permissionArn

AssociateResourceSharePermissionRequest.Builder permissionArn(String permissionArn)

Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

Parameters:

permissionArn - Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

Returns:

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

replace

AssociateResourceSharePermissionRequest.Builder replace(Boolean replace)

Specifies whether the specified permission should replace the existing permission associated with the resource share. Use true to replace the current permissions. Use false to add the permission to a resource share that currently doesn't have a permission. The default value is false.

A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don't set replace to true then the operation returns an error. This helps prevent accidental overwriting of a permission.

Parameters:

replace - Specifies whether the specified permission should replace the existing permission associated with the resource share. Use true to replace the current permissions. Use false to add the permission to a resource share that currently doesn't have a permission. The default value is false.

A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don't set replace to true then the operation returns an error. This helps prevent accidental overwriting of a permission.

Returns:

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

clientToken

AssociateResourceSharePermissionRequest.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.

permissionVersion

AssociateResourceSharePermissionRequest.Builder permissionVersion(Integer permissionVersion)

Specifies the version of the RAM permission to associate with the resource share. You can specify only the version that is currently set as the default version for the permission. If you also set the replace pararameter to true, then this operation updates an outdated version of the permission to the current default version.

You don't need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.

Parameters:

permissionVersion - Specifies the version of the RAM permission to associate with the resource share. You can specify only the version that is currently set as the default version for the permission. If you also set the replace pararameter to true, then this operation updates an outdated version of the permission to the current default version.

You don't need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.

Returns:

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

overrideConfiguration

AssociateResourceSharePermissionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder