Class: Aws::RAM::Types::CreatePermissionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RAM::Types::CreatePermissionRequest
- Defined in:
- gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#name ⇒ String
Specifies the name of the customer managed permission.
-
#permission_template_parameters ⇒ Array<Types::PermissionTemplateParameterDeclaration>
Specifies a list of template parameter declarations for this permission.
-
#policy_template ⇒ String
A string in JSON format string that contains the following elements of a resource-based policy:.
-
#resource_type ⇒ String
Specifies the name of the resource type that this customer managed permission applies to.
-
#tags ⇒ Array<Types::Tag>
Specifies a list of one or more tag key and value pairs to attach to the permission.
Instance Attribute Details
#client_token ⇒ String
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.
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |
#permission_template_parameters ⇒ Array<Types::PermissionTemplateParameterDeclaration>
Specifies a list of template parameter declarations for this
permission. Each declaration defines a named placeholder that can be
used in the policy template using the syntax @{parameterName}.
Template parameters can only appear in Condition Key and Condition
Value fields of the policy. When you associate this permission with
a resource share, you must provide values for all declared
parameters.
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |
#policy_template ⇒ String
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.
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |
#resource_type ⇒ String
Specifies the name of the resource type that this customer managed permission applies to.
The format is <service-code>:<resource-type> and is case
sensitive. For example, to specify an Amazon EC2 Subnet, you can use
the string ec2:Subnet. To see the list of valid values for this
parameter, query the ListResourceTypes operation. This value must
match the display name of the resource (available in
ListResourceTypes).
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Specifies a list of one or more tag key and value pairs to attach to the permission.
553 554 555 556 557 558 559 560 561 562 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 553 class CreatePermissionRequest < Struct.new( :name, :resource_type, :policy_template, :permission_template_parameters, :client_token, :tags) SENSITIVE = [] include Aws::Structure end |