amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.Types.DBInstanceRole

Description

 
Synopsis

Documentation

data DBInstanceRole Source #

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

See: newDBInstanceRole smart constructor.

Constructors

DBInstanceRole' 

Fields

  • featureName :: Maybe Text

    The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

  • roleArn :: Maybe Text

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

  • status :: Maybe Text

    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 Amazon Web Services 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 Amazon Web Services services on your behalf.

Instances

Instances details
FromXML DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Generic DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Associated Types

type Rep DBInstanceRole :: Type -> Type #

Read DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Show DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

NFData DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Methods

rnf :: DBInstanceRole -> () #

Eq DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

Hashable DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

type Rep DBInstanceRole Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceRole

type Rep DBInstanceRole = D1 ('MetaData "DBInstanceRole" "Amazonka.RDS.Types.DBInstanceRole" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DBInstanceRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "featureName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDBInstanceRole :: DBInstanceRole Source #

Create a value of DBInstanceRole with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:featureName:DBInstanceRole', dbInstanceRole_featureName - The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

$sel:roleArn:DBInstanceRole', dbInstanceRole_roleArn - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

$sel:status:DBInstanceRole', dbInstanceRole_status - 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 Amazon Web Services 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 Amazon Web Services services on your behalf.

dbInstanceRole_featureName :: Lens' DBInstanceRole (Maybe Text) Source #

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

dbInstanceRole_roleArn :: Lens' DBInstanceRole (Maybe Text) Source #

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

dbInstanceRole_status :: Lens' DBInstanceRole (Maybe Text) Source #

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 Amazon Web Services 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 Amazon Web Services services on your behalf.