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.AddRoleToDBInstance

Description

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

To add a role to a DB instance, the status of the DB instance must be available.

This command doesn't apply to RDS Custom.

Synopsis

Creating a Request

data AddRoleToDBInstance Source #

See: newAddRoleToDBInstance smart constructor.

Constructors

AddRoleToDBInstance' 

Fields

  • dbInstanceIdentifier :: Text

    The name of the DB instance to associate the IAM role with.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

  • featureName :: Text

    The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

Instances

Instances details
ToHeaders AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

toHeaders :: AddRoleToDBInstance -> [Header] #

ToPath AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

toPath :: AddRoleToDBInstance -> ByteString #

ToQuery AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

toQuery :: AddRoleToDBInstance -> QueryString #

AWSRequest AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Associated Types

type AWSResponse AddRoleToDBInstance #

Methods

request :: (Service -> Service) -> AddRoleToDBInstance -> Request AddRoleToDBInstance #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AddRoleToDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddRoleToDBInstance))) #

Generic AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Associated Types

type Rep AddRoleToDBInstance :: Type -> Type #

Methods

from :: AddRoleToDBInstance -> Rep AddRoleToDBInstance x #

to :: Rep AddRoleToDBInstance x -> AddRoleToDBInstance #

Read AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

readsPrec :: Int -> ReadS AddRoleToDBInstance #

readList :: ReadS [AddRoleToDBInstance] #

readPrec :: ReadPrec AddRoleToDBInstance #

readListPrec :: ReadPrec [AddRoleToDBInstance] #

Show AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

showsPrec :: Int -> AddRoleToDBInstance -> ShowS #

show :: AddRoleToDBInstance -> String #

showList :: [AddRoleToDBInstance] -> ShowS #

NFData AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

rnf :: AddRoleToDBInstance -> () #

Eq AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

(==) :: AddRoleToDBInstance -> AddRoleToDBInstance -> Bool #

(/=) :: AddRoleToDBInstance -> AddRoleToDBInstance -> Bool #

Hashable AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

hashWithSalt :: Int -> AddRoleToDBInstance -> Int #

hash :: AddRoleToDBInstance -> Int #

type AWSResponse AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

type AWSResponse AddRoleToDBInstance = AddRoleToDBInstanceResponse
type Rep AddRoleToDBInstance Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

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

newAddRoleToDBInstance Source #

Arguments

:: Text

AddRoleToDBInstance

-> Text

AddRoleToDBInstance

-> Text

AddRoleToDBInstance

-> AddRoleToDBInstance 

Create a value of AddRoleToDBInstance 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:

AddRoleToDBInstance, addRoleToDBInstance_dbInstanceIdentifier - The name of the DB instance to associate the IAM role with.

AddRoleToDBInstance, addRoleToDBInstance_roleArn - The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

AddRoleToDBInstance, addRoleToDBInstance_featureName - The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

Request Lenses

addRoleToDBInstance_dbInstanceIdentifier :: Lens' AddRoleToDBInstance Text Source #

The name of the DB instance to associate the IAM role with.

addRoleToDBInstance_roleArn :: Lens' AddRoleToDBInstance Text Source #

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

addRoleToDBInstance_featureName :: Lens' AddRoleToDBInstance Text Source #

The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

Destructuring the Response

data AddRoleToDBInstanceResponse Source #

See: newAddRoleToDBInstanceResponse smart constructor.

Constructors

AddRoleToDBInstanceResponse' 

Instances

Instances details
Generic AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Associated Types

type Rep AddRoleToDBInstanceResponse :: Type -> Type #

Methods

from :: AddRoleToDBInstanceResponse -> Rep AddRoleToDBInstanceResponse x #

to :: Rep AddRoleToDBInstanceResponse x -> AddRoleToDBInstanceResponse #

Read AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

readsPrec :: Int -> ReadS AddRoleToDBInstanceResponse #

readList :: ReadS [AddRoleToDBInstanceResponse] #

readPrec :: ReadPrec AddRoleToDBInstanceResponse #

readListPrec :: ReadPrec [AddRoleToDBInstanceResponse] #

Show AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

showsPrec :: Int -> AddRoleToDBInstanceResponse -> ShowS #

show :: AddRoleToDBInstanceResponse -> String #

showList :: [AddRoleToDBInstanceResponse] -> ShowS #

NFData AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

rnf :: AddRoleToDBInstanceResponse -> () #

Eq AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

Methods

(==) :: AddRoleToDBInstanceResponse -> AddRoleToDBInstanceResponse -> Bool #

(/=) :: AddRoleToDBInstanceResponse -> AddRoleToDBInstanceResponse -> Bool #

type Rep AddRoleToDBInstanceResponse Source # 
Instance details

Defined in Amazonka.RDS.AddRoleToDBInstance

type Rep AddRoleToDBInstanceResponse = D1 ('MetaData "AddRoleToDBInstanceResponse" "Amazonka.RDS.AddRoleToDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AddRoleToDBInstanceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAddRoleToDBInstanceResponse :: AddRoleToDBInstanceResponse Source #

Create a value of AddRoleToDBInstanceResponse with all optional fields omitted.

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