Interface CreatePermissionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreatePermissionRequest.Builder,
,CreatePermissionRequest> RamRequest.Builder
,SdkBuilder<CreatePermissionRequest.Builder,
,CreatePermissionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreatePermissionRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.Specifies the name of the customer managed permission.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.policyTemplate
(String policyTemplate) A string in JSON format string that contains the following elements of a resource-based policy:resourceType
(String resourceType) Specifies the name of the resource type that this customer managed permission applies to.tags
(Collection<Tag> tags) Specifies a list of one or more tag key and value pairs to attach to the permission.tags
(Consumer<Tag.Builder>... tags) Specifies a list of one or more tag key and value pairs to attach to the permission.Specifies a list of one or more tag key and value pairs to attach to the permission.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ram.model.RamRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.
- Parameters:
name
- Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceType
Specifies the name of the resource type that this customer managed permission applies to.
The format is
<service-code>:<resource-type>
and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the stringec2:subnet
. To see the list of valid values for this parameter, query the ListResourceTypes operation.- Parameters:
resourceType
- Specifies the name of the resource type that this customer managed permission applies to.The format is
<service-code>:<resource-type>
and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the stringec2:subnet
. To see the list of valid values for this parameter, query the ListResourceTypes operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
orPrincipal
elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. TheResource
comes from the ARN of the specific resource that you are sharing. ThePrincipal
comes from the list of identities added to the resource share.- Parameters:
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
orPrincipal
elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. TheResource
comes from the ARN of the specific resource that you are sharing. ThePrincipal
comes from the list of identities added to the resource share.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- 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 anIdempotentParameterMismatch
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies a list of one or more tag key and value pairs to attach to the permission.
- Parameters:
tags
- Specifies a list of one or more tag key and value pairs to attach to the permission.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies a list of one or more tag key and value pairs to attach to the permission.
- Parameters:
tags
- Specifies a list of one or more tag key and value pairs to attach to the permission.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies a list of one or more tag key and value pairs to attach to the permission.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreatePermissionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreatePermissionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-