libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.CreateEndpointAccess

Description

Creates a Redshift-managed VPC endpoint.

Synopsis

Creating a Request

data CreateEndpointAccess Source #

See: newCreateEndpointAccess smart constructor.

Constructors

CreateEndpointAccess' 

Fields

  • clusterIdentifier :: Maybe Text

    The cluster identifier of the cluster to access.

  • vpcSecurityGroupIds :: Maybe [Text]

    The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

  • resourceOwner :: Maybe Text

    The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

  • endpointName :: Text

    The Redshift-managed VPC endpoint name.

    An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

  • subnetGroupName :: Text

    The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

Instances

Instances details
Eq CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Read CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Show CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Generic CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Associated Types

type Rep CreateEndpointAccess :: Type -> Type #

NFData CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Methods

rnf :: CreateEndpointAccess -> () #

Hashable CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

AWSRequest CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

Associated Types

type AWSResponse CreateEndpointAccess #

ToHeaders CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

ToPath CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

ToQuery CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

type Rep CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

type Rep CreateEndpointAccess = D1 ('MetaData "CreateEndpointAccess" "Amazonka.Redshift.CreateEndpointAccess" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateEndpointAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateEndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.CreateEndpointAccess

newCreateEndpointAccess Source #

Create a value of CreateEndpointAccess 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:CreateEndpointAccess', createEndpointAccess_clusterIdentifier - The cluster identifier of the cluster to access.

$sel:vpcSecurityGroupIds:CreateEndpointAccess', createEndpointAccess_vpcSecurityGroupIds - The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

$sel:resourceOwner:CreateEndpointAccess', createEndpointAccess_resourceOwner - The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

$sel:endpointName:CreateEndpointAccess', createEndpointAccess_endpointName - The Redshift-managed VPC endpoint name.

An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

$sel:subnetGroupName:CreateEndpointAccess', createEndpointAccess_subnetGroupName - The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

Request Lenses

createEndpointAccess_clusterIdentifier :: Lens' CreateEndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster to access.

createEndpointAccess_vpcSecurityGroupIds :: Lens' CreateEndpointAccess (Maybe [Text]) Source #

The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

createEndpointAccess_resourceOwner :: Lens' CreateEndpointAccess (Maybe Text) Source #

The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

createEndpointAccess_endpointName :: Lens' CreateEndpointAccess Text Source #

The Redshift-managed VPC endpoint name.

An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

createEndpointAccess_subnetGroupName :: Lens' CreateEndpointAccess Text Source #

The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

Destructuring the Response

data EndpointAccess Source #

Describes a Redshift-managed VPC endpoint.

See: newEndpointAccess smart constructor.

Constructors

EndpointAccess' 

Fields

Instances

Instances details
Eq EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

Read EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

Show EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

Generic EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

Associated Types

type Rep EndpointAccess :: Type -> Type #

NFData EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

Methods

rnf :: EndpointAccess -> () #

Hashable EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

FromXML EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

type Rep EndpointAccess Source # 
Instance details

Defined in Amazonka.Redshift.Types.EndpointAccess

newEndpointAccess :: EndpointAccess Source #

Create a value of EndpointAccess 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:endpointName:EndpointAccess', endpointAccess_endpointName - The name of the endpoint.

$sel:endpointCreateTime:EndpointAccess', endpointAccess_endpointCreateTime - The time (UTC) that the endpoint was created.

$sel:subnetGroupName:EndpointAccess', endpointAccess_subnetGroupName - The subnet group name where Amazon Redshift chooses to deploy the endpoint.

$sel:address:EndpointAccess', endpointAccess_address - The DNS address of the endpoint.

$sel:clusterIdentifier:EndpointAccess', endpointAccess_clusterIdentifier - The cluster identifier of the cluster associated with the endpoint.

$sel:endpointStatus:EndpointAccess', endpointAccess_endpointStatus - The status of the endpoint.

$sel:vpcSecurityGroups:EndpointAccess', endpointAccess_vpcSecurityGroups - The security groups associated with the endpoint.

$sel:resourceOwner:EndpointAccess', endpointAccess_resourceOwner - The Amazon Web Services account ID of the owner of the cluster.

$sel:vpcEndpoint:EndpointAccess', endpointAccess_vpcEndpoint - Undocumented member.

$sel:port:EndpointAccess', endpointAccess_port - The port number on which the cluster accepts incoming connections.

Response Lenses

endpointAccess_endpointCreateTime :: Lens' EndpointAccess (Maybe UTCTime) Source #

The time (UTC) that the endpoint was created.

endpointAccess_subnetGroupName :: Lens' EndpointAccess (Maybe Text) Source #

The subnet group name where Amazon Redshift chooses to deploy the endpoint.

endpointAccess_address :: Lens' EndpointAccess (Maybe Text) Source #

The DNS address of the endpoint.

endpointAccess_clusterIdentifier :: Lens' EndpointAccess (Maybe Text) Source #

The cluster identifier of the cluster associated with the endpoint.

endpointAccess_vpcSecurityGroups :: Lens' EndpointAccess (Maybe [VpcSecurityGroupMembership]) Source #

The security groups associated with the endpoint.

endpointAccess_resourceOwner :: Lens' EndpointAccess (Maybe Text) Source #

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

endpointAccess_port :: Lens' EndpointAccess (Maybe Int) Source #

The port number on which the cluster accepts incoming connections.