Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.AuthorizeEndpointAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Grants access to a cluster.

Synopsis

data AuthorizeEndpointAccess = AuthorizeEndpointAccess' {
- clusterIdentifier :: Maybe Text
- vpcIds :: Maybe [Text]
- account :: Text
}
newAuthorizeEndpointAccess :: Text -> AuthorizeEndpointAccess
authorizeEndpointAccess_clusterIdentifier :: Lens' AuthorizeEndpointAccess (Maybe Text)
authorizeEndpointAccess_vpcIds :: Lens' AuthorizeEndpointAccess (Maybe [Text])
authorizeEndpointAccess_account :: Lens' AuthorizeEndpointAccess Text
data EndpointAuthorization = EndpointAuthorization' {
- status :: Maybe AuthorizationStatus
- allowedAllVPCs :: Maybe Bool
- endpointCount :: Maybe Int
- grantor :: Maybe Text
- clusterIdentifier :: Maybe Text
- grantee :: Maybe Text
- allowedVPCs :: Maybe [Text]
- clusterStatus :: Maybe Text
- authorizeTime :: Maybe ISO8601
}
newEndpointAuthorization :: EndpointAuthorization
endpointAuthorization_status :: Lens' EndpointAuthorization (Maybe AuthorizationStatus)
endpointAuthorization_allowedAllVPCs :: Lens' EndpointAuthorization (Maybe Bool)
endpointAuthorization_endpointCount :: Lens' EndpointAuthorization (Maybe Int)
endpointAuthorization_grantor :: Lens' EndpointAuthorization (Maybe Text)
endpointAuthorization_clusterIdentifier :: Lens' EndpointAuthorization (Maybe Text)
endpointAuthorization_grantee :: Lens' EndpointAuthorization (Maybe Text)
endpointAuthorization_allowedVPCs :: Lens' EndpointAuthorization (Maybe [Text])
endpointAuthorization_clusterStatus :: Lens' EndpointAuthorization (Maybe Text)
endpointAuthorization_authorizeTime :: Lens' EndpointAuthorization (Maybe UTCTime)

Creating a Request

data AuthorizeEndpointAccess Source #

See: newAuthorizeEndpointAccess smart constructor.

Constructors

AuthorizeEndpointAccess'
Fields clusterIdentifier :: Maybe Text The cluster identifier of the cluster to grant access to. vpcIds :: Maybe [Text] The virtual private cloud (VPC) identifiers to grant access to. account :: Text The Amazon Web Services account ID to grant access to.

Instances

Instances details

Eq AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods (==) :: AuthorizeEndpointAccess -> AuthorizeEndpointAccess -> Bool # (/=) :: AuthorizeEndpointAccess -> AuthorizeEndpointAccess -> Bool #
Read AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods readsPrec :: Int -> ReadS AuthorizeEndpointAccess # readList :: ReadS [AuthorizeEndpointAccess] # readPrec :: ReadPrec AuthorizeEndpointAccess # readListPrec :: ReadPrec [AuthorizeEndpointAccess] #
Show AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods showsPrec :: Int -> AuthorizeEndpointAccess -> ShowS # show :: AuthorizeEndpointAccess -> String # showList :: [AuthorizeEndpointAccess] -> ShowS #
Generic AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Associated Types type Rep AuthorizeEndpointAccess :: Type -> Type # Methods from :: AuthorizeEndpointAccess -> Rep AuthorizeEndpointAccess x # to :: Rep AuthorizeEndpointAccess x -> AuthorizeEndpointAccess #
NFData AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods rnf :: AuthorizeEndpointAccess -> () #
Hashable AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods hashWithSalt :: Int -> AuthorizeEndpointAccess -> Int # hash :: AuthorizeEndpointAccess -> Int #
AWSRequest AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Associated Types type AWSResponse AuthorizeEndpointAccess # Methods request :: AuthorizeEndpointAccess -> Request AuthorizeEndpointAccess # response :: MonadResource m => Logger -> Service -> Proxy AuthorizeEndpointAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AuthorizeEndpointAccess))) #
ToHeaders AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods toHeaders :: AuthorizeEndpointAccess -> [Header] #
ToPath AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods toPath :: AuthorizeEndpointAccess -> ByteString #
ToQuery AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess Methods toQuery :: AuthorizeEndpointAccess -> QueryString #
type Rep AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess type Rep AuthorizeEndpointAccess = D1 ('MetaData "AuthorizeEndpointAccess" "Amazonka.Redshift.AuthorizeEndpointAccess" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "AuthorizeEndpointAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse AuthorizeEndpointAccess Source #
Instance details Defined in Amazonka.Redshift.AuthorizeEndpointAccess type AWSResponse AuthorizeEndpointAccess = EndpointAuthorization

newAuthorizeEndpointAccess Source #

Arguments

:: Text	`$sel:account:AuthorizeEndpointAccess'`
-> AuthorizeEndpointAccess

Create a value of AuthorizeEndpointAccess 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:clusterIdentifier:AuthorizeEndpointAccess', authorizeEndpointAccess_clusterIdentifier - The cluster identifier of the cluster to grant access to.

$sel:vpcIds:AuthorizeEndpointAccess', authorizeEndpointAccess_vpcIds - The virtual private cloud (VPC) identifiers to grant access to.

$sel:account:AuthorizeEndpointAccess', authorizeEndpointAccess_account - The Amazon Web Services account ID to grant access to.

Request Lenses

authorizeEndpointAccess_clusterIdentifier :: Lens' AuthorizeEndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster to grant access to.

authorizeEndpointAccess_vpcIds :: Lens' AuthorizeEndpointAccess (Maybe [Text]) Source #

The virtual private cloud (VPC) identifiers to grant access to.

authorizeEndpointAccess_account :: Lens' AuthorizeEndpointAccess Text Source #

The Amazon Web Services account ID to grant access to.

Destructuring the Response

data EndpointAuthorization Source #

Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.

See: newEndpointAuthorization smart constructor.

Constructors

EndpointAuthorization'

Fields

status :: Maybe AuthorizationStatus
The status of the authorization action.
allowedAllVPCs :: Maybe Bool
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
endpointCount :: Maybe Int
The number of Redshift-managed VPC endpoints created for the authorization.
grantor :: Maybe Text
The Amazon Web Services account ID of the cluster owner.
clusterIdentifier :: Maybe Text
The cluster identifier.
grantee :: Maybe Text
The Amazon Web Services account ID of the grantee of the cluster.
allowedVPCs :: Maybe [Text]
The VPCs allowed access to the cluster.
clusterStatus :: Maybe Text
The status of the cluster.
authorizeTime :: Maybe ISO8601
The time (UTC) when the authorization was created.

Instances

Instances details

Eq EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods (==) :: EndpointAuthorization -> EndpointAuthorization -> Bool # (/=) :: EndpointAuthorization -> EndpointAuthorization -> Bool #
Read EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods readsPrec :: Int -> ReadS EndpointAuthorization # readList :: ReadS [EndpointAuthorization] # readPrec :: ReadPrec EndpointAuthorization # readListPrec :: ReadPrec [EndpointAuthorization] #
Show EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods showsPrec :: Int -> EndpointAuthorization -> ShowS # show :: EndpointAuthorization -> String # showList :: [EndpointAuthorization] -> ShowS #
Generic EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Associated Types type Rep EndpointAuthorization :: Type -> Type # Methods from :: EndpointAuthorization -> Rep EndpointAuthorization x # to :: Rep EndpointAuthorization x -> EndpointAuthorization #
NFData EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods rnf :: EndpointAuthorization -> () #
Hashable EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods hashWithSalt :: Int -> EndpointAuthorization -> Int # hash :: EndpointAuthorization -> Int #
FromXML EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization Methods parseXML :: [Node] -> Either String EndpointAuthorization #
type Rep EndpointAuthorization Source #
Instance details Defined in Amazonka.Redshift.Types.EndpointAuthorization type Rep EndpointAuthorization = D1 ('MetaData "EndpointAuthorization" "Amazonka.Redshift.Types.EndpointAuthorization" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "EndpointAuthorization'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizationStatus)) :: S1 ('MetaSel ('Just "allowedAllVPCs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "endpointCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "grantor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "allowedVPCs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "clusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))))

newEndpointAuthorization :: EndpointAuthorization Source #

Create a value of EndpointAuthorization 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:status:EndpointAuthorization', endpointAuthorization_status - The status of the authorization action.

$sel:allowedAllVPCs:EndpointAuthorization', endpointAuthorization_allowedAllVPCs - Indicates whether all VPCs in the grantee account are allowed access to the cluster.

$sel:endpointCount:EndpointAuthorization', endpointAuthorization_endpointCount - The number of Redshift-managed VPC endpoints created for the authorization.

$sel:grantor:EndpointAuthorization', endpointAuthorization_grantor - The Amazon Web Services account ID of the cluster owner.

$sel:clusterIdentifier:EndpointAuthorization', endpointAuthorization_clusterIdentifier - The cluster identifier.

$sel:grantee:EndpointAuthorization', endpointAuthorization_grantee - The Amazon Web Services account ID of the grantee of the cluster.

$sel:allowedVPCs:EndpointAuthorization', endpointAuthorization_allowedVPCs - The VPCs allowed access to the cluster.

$sel:clusterStatus:EndpointAuthorization', endpointAuthorization_clusterStatus - The status of the cluster.

$sel:authorizeTime:EndpointAuthorization', endpointAuthorization_authorizeTime - The time (UTC) when the authorization was created.

Response Lenses

endpointAuthorization_status :: Lens' EndpointAuthorization (Maybe AuthorizationStatus) Source #

The status of the authorization action.

endpointAuthorization_allowedAllVPCs :: Lens' EndpointAuthorization (Maybe Bool) Source #

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

endpointAuthorization_endpointCount :: Lens' EndpointAuthorization (Maybe Int) Source #

The number of Redshift-managed VPC endpoints created for the authorization.

endpointAuthorization_grantor :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the cluster owner.

endpointAuthorization_clusterIdentifier :: Lens' EndpointAuthorization (Maybe Text) Source #

The cluster identifier.

endpointAuthorization_grantee :: Lens' EndpointAuthorization (Maybe Text) Source #

The Amazon Web Services account ID of the grantee of the cluster.

endpointAuthorization_allowedVPCs :: Lens' EndpointAuthorization (Maybe [Text]) Source #

The VPCs allowed access to the cluster.

endpointAuthorization_clusterStatus :: Lens' EndpointAuthorization (Maybe Text) Source #

The status of the cluster.

endpointAuthorization_authorizeTime :: Lens' EndpointAuthorization (Maybe UTCTime) Source #

The time (UTC) when the authorization was created.