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

Description

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

Synopsis

Creating a Request

data CreateDBProxyEndpoint Source #

See: newCreateDBProxyEndpoint smart constructor.

Constructors

CreateDBProxyEndpoint' 

Fields

  • tags :: Maybe [Tag]
     
  • targetRole :: Maybe DBProxyEndpointTargetRole

    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

  • vpcSecurityGroupIds :: Maybe [Text]

    The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

  • dbProxyName :: Text

    The name of the DB proxy associated with the DB proxy endpoint that you create.

  • dbProxyEndpointName :: Text

    The name of the DB proxy endpoint to create.

  • vpcSubnetIds :: [Text]

    The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

Instances

Instances details
ToHeaders CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

toHeaders :: CreateDBProxyEndpoint -> [Header] #

ToPath CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

toPath :: CreateDBProxyEndpoint -> ByteString #

ToQuery CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

toQuery :: CreateDBProxyEndpoint -> QueryString #

AWSRequest CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Associated Types

type AWSResponse CreateDBProxyEndpoint #

Methods

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

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

Generic CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Associated Types

type Rep CreateDBProxyEndpoint :: Type -> Type #

Methods

from :: CreateDBProxyEndpoint -> Rep CreateDBProxyEndpoint x #

to :: Rep CreateDBProxyEndpoint x -> CreateDBProxyEndpoint #

Read CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

readsPrec :: Int -> ReadS CreateDBProxyEndpoint #

readList :: ReadS [CreateDBProxyEndpoint] #

readPrec :: ReadPrec CreateDBProxyEndpoint #

readListPrec :: ReadPrec [CreateDBProxyEndpoint] #

Show CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

showsPrec :: Int -> CreateDBProxyEndpoint -> ShowS #

show :: CreateDBProxyEndpoint -> String #

showList :: [CreateDBProxyEndpoint] -> ShowS #

NFData CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

rnf :: CreateDBProxyEndpoint -> () #

Eq CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

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

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

Hashable CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

hashWithSalt :: Int -> CreateDBProxyEndpoint -> Int #

hash :: CreateDBProxyEndpoint -> Int #

type AWSResponse CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

type AWSResponse CreateDBProxyEndpoint = CreateDBProxyEndpointResponse
type Rep CreateDBProxyEndpoint Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

type Rep CreateDBProxyEndpoint = D1 ('MetaData "CreateDBProxyEndpoint" "Amazonka.RDS.CreateDBProxyEndpoint" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateDBProxyEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "targetRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBProxyEndpointTargetRole)) :*: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "dbProxyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "dbProxyEndpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vpcSubnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCreateDBProxyEndpoint Source #

Arguments

:: Text

CreateDBProxyEndpoint

-> Text

CreateDBProxyEndpoint

-> CreateDBProxyEndpoint 

Create a value of CreateDBProxyEndpoint 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:tags:CreateDBProxyEndpoint', createDBProxyEndpoint_tags - Undocumented member.

CreateDBProxyEndpoint, createDBProxyEndpoint_targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

CreateDBProxyEndpoint, createDBProxyEndpoint_vpcSecurityGroupIds - The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

CreateDBProxyEndpoint, createDBProxyEndpoint_dbProxyName - The name of the DB proxy associated with the DB proxy endpoint that you create.

CreateDBProxyEndpoint, createDBProxyEndpoint_dbProxyEndpointName - The name of the DB proxy endpoint to create.

CreateDBProxyEndpoint, createDBProxyEndpoint_vpcSubnetIds - The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

Request Lenses

createDBProxyEndpoint_tags :: Lens' CreateDBProxyEndpoint (Maybe [Tag]) Source #

Undocumented member.

createDBProxyEndpoint_targetRole :: Lens' CreateDBProxyEndpoint (Maybe DBProxyEndpointTargetRole) Source #

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

createDBProxyEndpoint_vpcSecurityGroupIds :: Lens' CreateDBProxyEndpoint (Maybe [Text]) Source #

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

createDBProxyEndpoint_dbProxyName :: Lens' CreateDBProxyEndpoint Text Source #

The name of the DB proxy associated with the DB proxy endpoint that you create.

createDBProxyEndpoint_dbProxyEndpointName :: Lens' CreateDBProxyEndpoint Text Source #

The name of the DB proxy endpoint to create.

createDBProxyEndpoint_vpcSubnetIds :: Lens' CreateDBProxyEndpoint [Text] Source #

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

Destructuring the Response

data CreateDBProxyEndpointResponse Source #

See: newCreateDBProxyEndpointResponse smart constructor.

Constructors

CreateDBProxyEndpointResponse' 

Fields

  • dbProxyEndpoint :: Maybe DBProxyEndpoint

    The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Associated Types

type Rep CreateDBProxyEndpointResponse :: Type -> Type #

Methods

from :: CreateDBProxyEndpointResponse -> Rep CreateDBProxyEndpointResponse x #

to :: Rep CreateDBProxyEndpointResponse x -> CreateDBProxyEndpointResponse #

Read CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

readsPrec :: Int -> ReadS CreateDBProxyEndpointResponse #

readList :: ReadS [CreateDBProxyEndpointResponse] #

readPrec :: ReadPrec CreateDBProxyEndpointResponse #

readListPrec :: ReadPrec [CreateDBProxyEndpointResponse] #

Show CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

showsPrec :: Int -> CreateDBProxyEndpointResponse -> ShowS #

show :: CreateDBProxyEndpointResponse -> String #

showList :: [CreateDBProxyEndpointResponse] -> ShowS #

NFData CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

rnf :: CreateDBProxyEndpointResponse -> () #

Eq CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

Methods

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

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

type Rep CreateDBProxyEndpointResponse Source # 
Instance details

Defined in Amazonka.RDS.CreateDBProxyEndpoint

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

newCreateDBProxyEndpointResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateDBProxyEndpointResponse'

-> CreateDBProxyEndpointResponse 

Create a value of CreateDBProxyEndpointResponse 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:dbProxyEndpoint:CreateDBProxyEndpointResponse', createDBProxyEndpointResponse_dbProxyEndpoint - The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

$sel:httpStatus:CreateDBProxyEndpointResponse', createDBProxyEndpointResponse_httpStatus - The response's http status code.

Response Lenses

createDBProxyEndpointResponse_dbProxyEndpoint :: Lens' CreateDBProxyEndpointResponse (Maybe DBProxyEndpoint) Source #

The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

createDBProxyEndpointResponse_httpStatus :: Lens' CreateDBProxyEndpointResponse Int Source #

The response's http status code.