Class: Aws::RAM::Types::AssociateResourceShareRequest

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

Overview

Note:

When making an API call, you may pass AssociateResourceShareRequest data as a hash:

{
  resource_share_arn: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  client_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


267
268
269
270
271
272
273
274
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 267

class AssociateResourceShareRequest < Struct.new(
  :resource_share_arn,
  :resource_arns,
  :principals,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#principalsArray<String>

Specifies a list of principals to whom you want to the resource share. This can be null if you want to add only resources.

What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012

  • An Amazon Resoure 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

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.

Returns:

  • (Array<String>)


267
268
269
270
271
272
273
274
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 267

class AssociateResourceShareRequest < Struct.new(
  :resource_share_arn,
  :resource_arns,
  :principals,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnsArray<String>

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be null if you want to add only principals.

Returns:

  • (Array<String>)


267
268
269
270
271
272
273
274
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 267

class AssociateResourceShareRequest < Struct.new(
  :resource_share_arn,
  :resource_arns,
  :principals,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arnString

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add principals or resources to.

Returns:

  • (String)


267
268
269
270
271
272
273
274
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 267

class AssociateResourceShareRequest < Struct.new(
  :resource_share_arn,
  :resource_arns,
  :principals,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end