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

Class: Aws::RDS::Types::DBInstanceRole

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#feature_nameString

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

Returns:

  • (String)


5911
5912
5913
5914
5915
5916
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 5911

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

#role_arnString

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

Returns:

  • (String)


5911
5912
5913
5914
5915
5916
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 5911

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

#statusString

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

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

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

  • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.

Returns:

  • (String)


5911
5912
5913
5914
5915
5916
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 5911

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