Package software.amazon.awssdk.services.ram.model

Class CreatePermissionVersionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePermissionVersionRequest.Builder,CreatePermissionVersionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePermissionVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePermissionVersionRequest.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 customer managed permission you're creating a new version for.
String	policyTemplate()	A string in JSON format string that contains the following elements of a resource-based policy:
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePermissionVersionRequest.Builder>	serializableBuilderClass()
CreatePermissionVersionRequest.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

permissionArn

public final String permissionArn()

Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.

Returns:

Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.

policyTemplate

public final String policyTemplate()

A string in JSON format string that contains the following elements of a resource-based policy:

• Effect: must be set to ALLOW.

• Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

• Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

Returns:

A string in JSON format string that contains the following elements of a resource-based policy:

• Effect: must be set to ALLOW.

• Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

• Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

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.

toBuilder

public CreatePermissionVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePermissionVersionRequest.Builder,CreatePermissionVersionRequest>

Specified by:

toBuilder in class RamRequest

builder

public static CreatePermissionVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePermissionVersionRequest.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