Amazonka.DocumentDB.Types.DBClusterRole

Documentation

data DBClusterRole

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

See: newDBClusterRole smart constructor.

Constructors

DBClusterRole'

Fields

• roleArn :: Maybe Text

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

• status :: Maybe Text

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

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
  • PENDING - The IAMrole ARN is being associated with the cluster.
  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

Instances

FromXML DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

parseXML :: [Node] -> Either String DBClusterRole

Generic DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Associated Types

type Rep DBClusterRole :: Type -> Type

Methods

from :: DBClusterRole -> Rep DBClusterRole x

to :: Rep DBClusterRole x -> DBClusterRole

Read DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

readsPrec :: Int -> ReadS DBClusterRole

readList :: ReadS [DBClusterRole]

readPrec :: ReadPrec DBClusterRole

readListPrec :: ReadPrec [DBClusterRole]

Show DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

showsPrec :: Int -> DBClusterRole -> ShowS

show :: DBClusterRole -> String

showList :: [DBClusterRole] -> ShowS

NFData DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

rnf :: DBClusterRole -> ()

Eq DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

(==) :: DBClusterRole -> DBClusterRole -> Bool

(/=) :: DBClusterRole -> DBClusterRole -> Bool

Hashable DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

Methods

hashWithSalt :: Int -> DBClusterRole -> Int

hash :: DBClusterRole -> Int

type Rep DBClusterRole

Defined in Amazonka.DocumentDB.Types.DBClusterRole

type Rep DBClusterRole = D1 ('MetaData "DBClusterRole" "Amazonka.DocumentDB.Types.DBClusterRole" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBClusterRole'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterRole :: DBClusterRole

Create a value of DBClusterRole 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:roleArn:DBClusterRole', dbClusterRole_roleArn - The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

$sel:status:DBClusterRole', dbClusterRole_status - Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

• ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
• PENDING - The IAMrole ARN is being associated with the cluster.
• INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

dbClusterRole_roleArn :: Lens' DBClusterRole (Maybe Text)

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

dbClusterRole_status :: Lens' DBClusterRole (Maybe Text)

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

• ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
• PENDING - The IAMrole ARN is being associated with the cluster.
• INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.