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

Description

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Synopsis

Creating a Request

data AuthorizeDBSecurityGroupIngress Source #

See: newAuthorizeDBSecurityGroupIngress smart constructor.

Constructors

AuthorizeDBSecurityGroupIngress' 

Fields

  • cidrip :: Maybe Text

    The IP range to authorize.

  • eC2SecurityGroupId :: Maybe Text

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • eC2SecurityGroupName :: Maybe Text

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • eC2SecurityGroupOwnerId :: Maybe Text

    Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • dbSecurityGroupName :: Text

    The name of the DB security group to add authorization to.

Instances

Instances details
ToHeaders AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

toHeaders :: AuthorizeDBSecurityGroupIngress -> [Header] #

ToPath AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

toPath :: AuthorizeDBSecurityGroupIngress -> ByteString #

ToQuery AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

toQuery :: AuthorizeDBSecurityGroupIngress -> QueryString #

AWSRequest AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Associated Types

type AWSResponse AuthorizeDBSecurityGroupIngress #

Methods

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

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

Generic AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Associated Types

type Rep AuthorizeDBSecurityGroupIngress :: Type -> Type #

Methods

from :: AuthorizeDBSecurityGroupIngress -> Rep AuthorizeDBSecurityGroupIngress x #

to :: Rep AuthorizeDBSecurityGroupIngress x -> AuthorizeDBSecurityGroupIngress #

Read AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

readsPrec :: Int -> ReadS AuthorizeDBSecurityGroupIngress #

readList :: ReadS [AuthorizeDBSecurityGroupIngress] #

readPrec :: ReadPrec AuthorizeDBSecurityGroupIngress #

readListPrec :: ReadPrec [AuthorizeDBSecurityGroupIngress] #

Show AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

showsPrec :: Int -> AuthorizeDBSecurityGroupIngress -> ShowS #

show :: AuthorizeDBSecurityGroupIngress -> String #

showList :: [AuthorizeDBSecurityGroupIngress] -> ShowS #

NFData AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

rnf :: AuthorizeDBSecurityGroupIngress -> () #

Eq AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

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

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

Hashable AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

hashWithSalt :: Int -> AuthorizeDBSecurityGroupIngress -> Int #

hash :: AuthorizeDBSecurityGroupIngress -> Int #

type AWSResponse AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

type AWSResponse AuthorizeDBSecurityGroupIngress = AuthorizeDBSecurityGroupIngressResponse
type Rep AuthorizeDBSecurityGroupIngress Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

type Rep AuthorizeDBSecurityGroupIngress = D1 ('MetaData "AuthorizeDBSecurityGroupIngress" "Amazonka.RDS.AuthorizeDBSecurityGroupIngress" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AuthorizeDBSecurityGroupIngress'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cidrip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eC2SecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eC2SecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eC2SecurityGroupOwnerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbSecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newAuthorizeDBSecurityGroupIngress Source #

Arguments

:: Text

AuthorizeDBSecurityGroupIngress

-> AuthorizeDBSecurityGroupIngress 

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

AuthorizeDBSecurityGroupIngress, authorizeDBSecurityGroupIngress_cidrip - The IP range to authorize.

AuthorizeDBSecurityGroupIngress, authorizeDBSecurityGroupIngress_eC2SecurityGroupId - Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

AuthorizeDBSecurityGroupIngress, authorizeDBSecurityGroupIngress_eC2SecurityGroupName - Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

AuthorizeDBSecurityGroupIngress, authorizeDBSecurityGroupIngress_eC2SecurityGroupOwnerId - Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

AuthorizeDBSecurityGroupIngress, authorizeDBSecurityGroupIngress_dbSecurityGroupName - The name of the DB security group to add authorization to.

Request Lenses

authorizeDBSecurityGroupIngress_cidrip :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

The IP range to authorize.

authorizeDBSecurityGroupIngress_eC2SecurityGroupId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_eC2SecurityGroupName :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_eC2SecurityGroupOwnerId :: Lens' AuthorizeDBSecurityGroupIngress (Maybe Text) Source #

Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

authorizeDBSecurityGroupIngress_dbSecurityGroupName :: Lens' AuthorizeDBSecurityGroupIngress Text Source #

The name of the DB security group to add authorization to.

Destructuring the Response

data AuthorizeDBSecurityGroupIngressResponse Source #

See: newAuthorizeDBSecurityGroupIngressResponse smart constructor.

Constructors

AuthorizeDBSecurityGroupIngressResponse' 

Fields

Instances

Instances details
Generic AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Associated Types

type Rep AuthorizeDBSecurityGroupIngressResponse :: Type -> Type #

Methods

from :: AuthorizeDBSecurityGroupIngressResponse -> Rep AuthorizeDBSecurityGroupIngressResponse x #

to :: Rep AuthorizeDBSecurityGroupIngressResponse x -> AuthorizeDBSecurityGroupIngressResponse #

Read AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

readsPrec :: Int -> ReadS AuthorizeDBSecurityGroupIngressResponse #

readList :: ReadS [AuthorizeDBSecurityGroupIngressResponse] #

readPrec :: ReadPrec AuthorizeDBSecurityGroupIngressResponse #

readListPrec :: ReadPrec [AuthorizeDBSecurityGroupIngressResponse] #

Show AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

showsPrec :: Int -> AuthorizeDBSecurityGroupIngressResponse -> ShowS #

show :: AuthorizeDBSecurityGroupIngressResponse -> String #

showList :: [AuthorizeDBSecurityGroupIngressResponse] -> ShowS #

NFData AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

rnf :: AuthorizeDBSecurityGroupIngressResponse -> () #

Eq AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

Methods

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

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

type Rep AuthorizeDBSecurityGroupIngressResponse Source # 
Instance details

Defined in Amazonka.RDS.AuthorizeDBSecurityGroupIngress

type Rep AuthorizeDBSecurityGroupIngressResponse = D1 ('MetaData "AuthorizeDBSecurityGroupIngressResponse" "Amazonka.RDS.AuthorizeDBSecurityGroupIngress" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "AuthorizeDBSecurityGroupIngressResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSecurityGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBSecurityGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAuthorizeDBSecurityGroupIngressResponse Source #

Arguments

:: Int

$sel:httpStatus:AuthorizeDBSecurityGroupIngressResponse'

-> AuthorizeDBSecurityGroupIngressResponse 

Create a value of AuthorizeDBSecurityGroupIngressResponse 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:dbSecurityGroup:AuthorizeDBSecurityGroupIngressResponse', authorizeDBSecurityGroupIngressResponse_dbSecurityGroup - Undocumented member.

$sel:httpStatus:AuthorizeDBSecurityGroupIngressResponse', authorizeDBSecurityGroupIngressResponse_httpStatus - The response's http status code.

Response Lenses

authorizeDBSecurityGroupIngressResponse_dbSecurityGroup :: Lens' AuthorizeDBSecurityGroupIngressResponse (Maybe DBSecurityGroup) Source #

Undocumented member.

authorizeDBSecurityGroupIngressResponse_httpStatus :: Lens' AuthorizeDBSecurityGroupIngressResponse Int Source #

The response's http status code.