Class AssociateResourceSharePermissionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,
AssociateResourceSharePermissionRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.final Integer
Specifies the version of the RAM permission to associate with the resource share.final Boolean
replace()
Specifies whether the specified permission should replace the existing permission associated with the resource share.final String
Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.static Class
<? extends AssociateResourceSharePermissionRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Specifies whether the specified permission should replace the existing permission associated with the resource share. Use
true
to replace the current permissions. Usefalse
to 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
replace
totrue
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. Usefalse
to 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
replace
totrue
then the operation returns an error. This helps prevent accidental overwriting of a permission.
-
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:
- 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.
-
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 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
replace
pararameter 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssociateResourceSharePermissionRequest.Builder,
AssociateResourceSharePermissionRequest> - Specified by:
toBuilder
in classRamRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AssociateResourceSharePermissionRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields