Package software.amazon.awscdk.services.redshift

Class CfnEndpointAccess

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.redshift.CfnEndpointAccess
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.791Z") @Stability(Stable) public class CfnEndpointAccess extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::EndpointAccess.

Creates a Redshift-managed VPC endpoint.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnEndpointAccess cfnEndpointAccess = CfnEndpointAccess.Builder.create(this, "MyCfnEndpointAccess")
         .clusterIdentifier("clusterIdentifier")
         .endpointName("endpointName")
         .subnetGroupName("subnetGroupName")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         // the properties below are optional
         .resourceOwner("resourceOwner")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEndpointAccess

      protected CfnEndpointAccess(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEndpointAccess

      protected CfnEndpointAccess(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEndpointAccess

      @Stability(Stable) public CfnEndpointAccess(@NotNull Construct scope, @NotNull String id, @NotNull CfnEndpointAccessProps props)
      Create a new AWS::Redshift::EndpointAccess.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAddress

      @Stability(Stable) @NotNull public String getAttrAddress()
      The DNS address of the endpoint.

    • getAttrEndpointCreateTime

      @Stability(Stable) @NotNull public String getAttrEndpointCreateTime()
      The time (UTC) that the endpoint was created.

    • getAttrEndpointStatus

      @Stability(Stable) @NotNull public String getAttrEndpointStatus()
      The status of the endpoint.

    • getAttrPort

      @Stability(Stable) @NotNull public Number getAttrPort()
      The port number on which the cluster accepts incoming connections.

    • getAttrVpcEndpointNetworkInterfaces

      @Stability(Stable) @NotNull public IResolvable getAttrVpcEndpointNetworkInterfaces()

    • getAttrVpcEndpointVpcEndpointId

      @Stability(Stable) @NotNull public String getAttrVpcEndpointVpcEndpointId()
      The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

    • getAttrVpcEndpointVpcId

      @Stability(Stable) @NotNull public String getAttrVpcEndpointVpcId()
      The VPC identifier that the endpoint is associated.

    • getAttrVpcSecurityGroups

      @Stability(Stable) @NotNull public IResolvable getAttrVpcSecurityGroups()
      The security groups associated with the endpoint.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClusterIdentifier

      @Stability(Stable) @NotNull public String getClusterIdentifier()
      The cluster identifier of the cluster associated with the endpoint.

    • setClusterIdentifier

      @Stability(Stable) public void setClusterIdentifier(@NotNull String value)
      The cluster identifier of the cluster associated with the endpoint.

    • getEndpointName

      @Stability(Stable) @NotNull public String getEndpointName()
      The name of the endpoint.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@NotNull String value)
      The name of the endpoint.

    • getSubnetGroupName

      @Stability(Stable) @NotNull public String getSubnetGroupName()
      The subnet group name where Amazon Redshift chooses to deploy the endpoint.

    • setSubnetGroupName

      @Stability(Stable) public void setSubnetGroupName(@NotNull String value)
      The subnet group name where Amazon Redshift chooses to deploy the endpoint.

    • getVpcSecurityGroupIds

      @Stability(Stable) @NotNull public List<String> getVpcSecurityGroupIds()
      The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@NotNull List<String> value)
      The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    • getResourceOwner

      @Stability(Stable) @Nullable public String getResourceOwner()
      The AWS account ID of the owner of the cluster.

    • setResourceOwner

      @Stability(Stable) public void setResourceOwner(@Nullable String value)
      The AWS account ID of the owner of the cluster.