Package software.amazon.awscdk.services.redshift

Class CfnEndpointAccess

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.redshift.CfnEndpointAccess

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:08.677Z")
@Stability(Stable)
public class CfnEndpointAccess
extends CfnResource
implements IInspectable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-endpointaccess.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEndpointAccess.Builder	A fluent builder for CfnEndpointAccess.
static interface	CfnEndpointAccess.NetworkInterfaceProperty	Describes a network interface.
static interface	CfnEndpointAccess.VpcEndpointProperty	The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
static interface	CfnEndpointAccess.VpcSecurityGroupProperty	The security groups associated with the endpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEndpointAccess(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointAccess(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEndpointAccess(software.constructs.Construct scope, String id, CfnEndpointAccessProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAddress()	The DNS address of the endpoint.
String	getAttrEndpointCreateTime()	The time (UTC) that the endpoint was created.
String	getAttrEndpointStatus()	The status of the endpoint.
Number	getAttrPort()	The port number on which the cluster accepts incoming connections.
IResolvable	getAttrVpcEndpoint()	The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
IResolvable	getAttrVpcEndpointNetworkInterfaces()
String	getAttrVpcEndpointVpcEndpointId()	The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
String	getAttrVpcEndpointVpcId()	The VPC identifier that the endpoint is associated.
IResolvable	getAttrVpcSecurityGroups()	The security groups associated with the endpoint.
protected Map<String,Object>	getCfnProperties()
String	getClusterIdentifier()	The cluster identifier of the cluster associated with the endpoint.
String	getEndpointName()	The name of the endpoint.
String	getResourceOwner()	The AWS account ID of the owner of the cluster.
String	getSubnetGroupName()	The subnet group name where Amazon Redshift chooses to deploy the endpoint.
List<String>	getVpcSecurityGroupIds()	The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClusterIdentifier(String value)	The cluster identifier of the cluster associated with the endpoint.
void	setEndpointName(String value)	The name of the endpoint.
void	setResourceOwner(String value)	The AWS account ID of the owner of the cluster.
void	setSubnetGroupName(String value)	The subnet group name where Amazon Redshift chooses to deploy the endpoint.
void	setVpcSecurityGroupIds(List<String> value)	The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEndpointAccessProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrVpcEndpoint

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

The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

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.