software.amazon.awssdk.services.ram.model

Class AssociateResourceSharePermissionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ram.model.RamRequest

software.amazon.awssdk.services.ram.model.AssociateResourceSharePermissionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,AssociateResourceSharePermissionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AssociateResourceSharePermissionRequest
extends RamRequest
implements ToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,AssociateResourceSharePermissionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssociateResourceSharePermissionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AssociateResourceSharePermissionRequest.Builder	builder()
String	clientToken() Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	permissionArn() Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.
Integer	permissionVersion() Specifies the version of the RAM permission to associate with the resource share.
Boolean	replace() Specifies whether the specified permission should replace the existing permission associated with the resource share.
String	resourceShareArn() Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateResourceSharePermissionRequest.Builder>	serializableBuilderClass()
AssociateResourceSharePermissionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

resourceShareArn

public final String resourceShareArn()

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

Returns:

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

permissionArn

public final 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.

Returns:

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.

replace

public final 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.

Returns:

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.

clientToken

public final 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.

Returns:

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.

permissionVersion

public final 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.

Returns:

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.

toBuilder

public AssociateResourceSharePermissionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,AssociateResourceSharePermissionRequest>

Specified by:

toBuilder in class RamRequest

builder

public static AssociateResourceSharePermissionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociateResourceSharePermissionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo