Class: Aws::RAM::Types::CreateResourceShareRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ram/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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

Returns:

  • (Boolean) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  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.

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

  • (String) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Specifies the name of the resource share.

Returns:

  • (String) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  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.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (Array<String>) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  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: ‘123456789012`

  • An [Amazon Resource Name (ARN)] of an organization in Organizations, for example: ‘organizations::123456789012:organization/o-exampleorgid`

  • An ARN of an organizational unit (OU) in Organizations, for example: ‘organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123`

  • An ARN of an IAM role, for example: ‘iam::123456789012:role/rolename`

  • An ARN of an IAM user, for example: ‘iam::123456789012user/username`

<note markdown=“1”> Not all resource types can be shared with IAM roles and users. For more information, see [Sharing with IAM roles and users] in the *Resource Access Manager User Guide*.

</note>

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types

Returns:

  • (Array<String>) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  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.

Returns:

  • (Array<String>) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  SENSITIVE = []
  include Aws::Structure
end

#sources ⇒ Array<String>

Specifies from which source accounts the service principal has access to the resources in this resource share.

Returns:

  • (Array<String>) 


687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  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.

Returns:



687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/aws-sdk-ram/types.rb', line 687

class CreateResourceShareRequest < Struct.new(
  :name,
  :resource_arns,
  :principals,
  :tags,
  :allow_external_principals,
  :client_token,
  :permission_arns,
  :sources)
  SENSITIVE = []
  include Aws::Structure
end