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

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 CreateResourceShareRequest data as a hash:

{
  name: "String", # required
  resource_arns: ["String"],
  principals: ["String"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  allow_external_principals: false,
  client_token: "String",
  permission_arns: ["String"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_external_principalsBoolean

Indicates whether principals outside your organization in Organizations can be associated with a resource share.

Returns:

  • (Boolean)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#client_tokenString

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

  • (String)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#nameString

The name of the resource share.

Returns:

  • (String)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#permission_arnsArray<String>

The Amazon Resource Names (ARNs) of the permissions 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. Only one permission can be associated with each resource type in a resource share.

Returns:

  • (Array<String>)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#principalsArray<String>

The principals to associate with the resource share. The possible values are:

  • An Amazon Web Services account ID

  • An Amazon Resource Name (ARN) of an organization in Organizations

  • An ARN of an organizational unit (OU) in Organizations

  • An ARN of an IAM role

  • An ARN of an IAM user

Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

Returns:

  • (Array<String>)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#resource_arnsArray<String>

The ARNs of the resources to associate with the resource share.

Returns:

  • (Array<String>)


276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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

#tagsArray<Types::Tag>

One or more tags.

Returns:



276
277
278
279
280
281
282
283
284
285
286
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 276

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