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

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)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#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)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#nameString

Specifies the name of the resource share.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#permission_arnsArray<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.

Returns:

  • (Array<String>)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#principalsArray<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 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>)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#resource_arnsArray<String>

Specifies a list of one or more ARNs of the resources to associate with the resource share.

Returns:

  • (Array<String>)


404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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

#tagsArray<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:



404
405
406
407
408
409
410
411
412
413
414
# File 'gems/aws-sdk-ram/lib/aws-sdk-ram/types.rb', line 404

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