Class CreatePermissionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePermissionRequest.Builder,
CreatePermissionRequest>
-
Nested Class Summary
-
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 boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
Specifies the name of the customer managed permission.final String
A string in JSON format string that contains the following elements of a resource-based policy:final String
Specifies the name of the resource type that this customer managed permission applies to.static Class
<? extends CreatePermissionRequest.Builder> tags()
Specifies a list of one or more tag key and value pairs to attach to the permission.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
-
name
Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.
- Returns:
- Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.
-
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:
- 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.
-
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:
- 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. -
-
-
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Specifies a list of one or more tag key and value pairs to attach to the permission.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Specifies a list of one or more tag key and value pairs to attach to the permission.
-
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<CreatePermissionRequest.Builder,
CreatePermissionRequest> - Specified by:
toBuilder
in classRamRequest
- Returns:
- a builder for type T
-
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
-