You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DocDB::Types::DBClusterRole

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

Overview

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#role_arnString

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

Returns:

  • (String)


1359
1360
1361
1362
1363
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1359

class DBClusterRole < Struct.new(
  :role_arn,
  :status)
  include Aws::Structure
end

#statusString

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - The IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - The IAM role ARN is being associated with the DB cluster.

  • INVALID - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the IAM role to access other AWS services on your behalf.

Returns:

  • (String)


1359
1360
1361
1362
1363
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1359

class DBClusterRole < Struct.new(
  :role_arn,
  :status)
  include Aws::Structure
end