Class: Aws::RAM::Types::AssociateResourceSharePermissionRequest

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

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


147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ram/types.rb', line 147

class AssociateResourceSharePermissionRequest < Struct.new(
  :resource_share_arn,
  :permission_arn,
  :replace,
  :client_token,
  :permission_version)
  SENSITIVE = []
  include Aws::Structure
end

#permission_arn ⇒ String

Specifies the [Amazon Resource Name (ARN)] of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the

Permissions library][2

page in the RAM console and then choose the

name of the permission. The ARN is displayed on the detail page.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: console.aws.amazon.com/ram/home#Permissions:

Returns:

  • (String) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ram/types.rb', line 147

class AssociateResourceSharePermissionRequest < Struct.new(
  :resource_share_arn,
  :permission_arn,
  :replace,
  :client_token,
  :permission_version)
  SENSITIVE = []
  include Aws::Structure
end

#permission_version ⇒ Integer

Specifies the version of the RAM permission to associate with the resource share. You can specify only the version that is currently set as the default version for the permission. If you also set the ‘replace` pararameter to `true`, then this operation updates an outdated version of the permission to the current default version.

<note markdown=“1”> You don’t need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.

</note>

Returns:

  • (Integer) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ram/types.rb', line 147

class AssociateResourceSharePermissionRequest < Struct.new(
  :resource_share_arn,
  :permission_arn,
  :replace,
  :client_token,
  :permission_version)
  SENSITIVE = []
  include Aws::Structure
end

#replace ⇒ Boolean

Specifies whether the specified permission should replace the existing permission associated with the resource share. Use ‘true` to replace the current permissions. Use `false` to add the permission to a resource share that currently doesn’t have a permission. The default value is ‘false`.

<note markdown=“1”> A resource share can have only one permission per resource type. If a resource share already has a permission for the specified resource type and you don’t set ‘replace` to `true` then the operation returns an error. This helps prevent accidental overwriting of a permission.

</note>

Returns:

  • (Boolean) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ram/types.rb', line 147

class AssociateResourceSharePermissionRequest < Struct.new(
  :resource_share_arn,
  :permission_arn,
  :replace,
  :client_token,
  :permission_version)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arn ⇒ String

Specifies the [Amazon Resource Name (ARN)] of the resource share to which you want to add or replace permissions.

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

Returns:

  • (String) 


147
148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ram/types.rb', line 147

class AssociateResourceSharePermissionRequest < Struct.new(
  :resource_share_arn,
  :permission_arn,
  :replace,
  :client_token,
  :permission_version)
  SENSITIVE = []
  include Aws::Structure
end