Class: Aws::RAM::Types::CreateResourceShareRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RAM::Types::CreateResourceShareRequest
- Defined in:
- gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allow_external_principals ⇒ Boolean
Specifies whether principals outside your organization in Organizations can be associated with a resource share.
-
#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 resource share.
-
#permission_arns ⇒ Array<String>
Specifies the [Amazon Resource Names (ARNs)][1] of the RAM permission to associate with the resource share.
-
#permission_template_parameters ⇒ Array<Types::PermissionArnAndTemplateParameters>
Specifies the template parameter values for each permission being associated that has template parameters.
-
#principals ⇒ Array<String>
Specifies a list of one or more principals to associate with the resource share.
-
#resource_arns ⇒ Array<String>
Specifies a list of one or more ARNs of the resources to associate with the resource share.
-
#resource_share_configuration ⇒ Types::ResourceShareConfiguration
Specifies the configuration of this resource share.
-
#sources ⇒ Array<String>
Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share.
-
#tags ⇒ Array<Types::Tag>
Specifies one or more tags to attach to the resource share itself.
Instance Attribute Details
#allow_external_principals ⇒ Boolean
Specifies whether principals outside your organization in
Organizations can be associated with a resource share. A value of
true lets you share with individual Amazon Web Services accounts
that are not in your organization. A value of false only has
meaning if your account is a member of an Amazon Web Services
Organization. The default value is true.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#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.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
Specifies the name of the resource share.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#permission_arns ⇒ Array<String>
Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#permission_template_parameters ⇒ Array<Types::PermissionArnAndTemplateParameters>
Specifies the template parameter values for each permission being associated that has template parameters. Each entry maps a permission ARN to the parameter values to use when rendering the permission template for this resource share. You must provide values for all parameters declared in each permission template.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#principals ⇒ Array<String>
Specifies a list of one or more principals to associate with the resource share.
You can include the following values:
An Amazon Web Services account ID, for example:
123456789012An Amazon Resource Name (ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgidAn ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123An ARN of an IAM role, for example:
iam::123456789012:role/rolenameAn ARN of an IAM user, for example:
iam::123456789012user/usernameA service principal name, for example:
service-id.amazonaws.com
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#resource_arns ⇒ Array<String>
Specifies a list of one or more ARNs of the resources to associate with the resource share.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#resource_share_configuration ⇒ Types::ResourceShareConfiguration
Specifies the configuration of this resource share.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#sources ⇒ Array<String>
Specifies source constraints (accounts, ARNs, organization IDs, or organization paths) that limit when service principals can access resources in this resource share. When a service principal attempts to access a shared resource, validation is performed to ensure the request originates from one of the specified sources. This helps prevent confused deputy attacks by applying constraints on where service principals can access resources from.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 809 class CreateResourceShareRequest < Struct.new( :name, :resource_arns, :principals, :tags, :allow_external_principals, :client_token, :permission_arns, :sources, :permission_template_parameters, :resource_share_configuration) SENSITIVE = [] include Aws::Structure end |