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("software.amazon.awssdk:codegen") public final class AssociateResourceSharePermissionRequest extends RamRequest implements ToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,AssociateResourceSharePermissionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAssociateResourceSharePermissionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AssociateResourceSharePermissionRequest.Builderbuilder()StringclientToken()Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringpermissionArn()Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.IntegerpermissionVersion()Specifies the version of the RAM permission to associate with the resource share.Booleanreplace()Specifies whether the specified permission should replace the existing permission associated with the resource share.StringresourceShareArn()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.BuildertoBuilder()StringtoString()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
trueto replace the current permissions. Usefalseto add the permission to a resource share that currently doesn't have a permission. The default value isfalse.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
replacetotruethen 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
trueto replace the current permissions. Usefalseto add the permission to a resource share that currently doesn't have a permission. The default value isfalse.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
replacetotruethen 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 anIdempotentParameterMismatcherror.- 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 anIdempotentParameterMismatcherror.
-
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
replacepararameter totrue, 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
replacepararameter totrue, 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:
toBuilderin interfaceToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,AssociateResourceSharePermissionRequest>- Specified by:
toBuilderin classRamRequest
-
builder
public static AssociateResourceSharePermissionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends AssociateResourceSharePermissionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-