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:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-09T19:25:26.049Z")
 @Stability(value=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")
         .endpointName("endpointName")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         // the properties below are optional
         .clusterIdentifier("clusterIdentifier")
         .resourceOwner("resourceOwner")
         .subnetGroupName("subnetGroupName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEndpointAccess.Builder A fluent builder for CfnEndpointAccess.
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.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpointAccess(Construct scope, String id, CfnEndpointAccessProps props) Create a new `AWS::Redshift::EndpointAccess`.
protected	CfnEndpointAccess(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointAccess(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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	getAttrVpcSecurityGroups()
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.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpointAccess

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

CfnEndpointAccess

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

CfnEndpointAccess

@Stability(value=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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrAddress()

The DNS address of the endpoint.

getAttrEndpointCreateTime

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointCreateTime()

The time (UTC) that the endpoint was created.

getAttrEndpointStatus

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointStatus()

The status of the endpoint.

getAttrPort

@Stability(value=Stable)
 @NotNull
public Number getAttrPort()

The port number on which the cluster accepts incoming connections.

getAttrVpcSecurityGroups

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrVpcSecurityGroups()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEndpointName

@Stability(value=Stable)
 @NotNull
public String getEndpointName()

The name of the endpoint.

setEndpointName

@Stability(value=Stable)
public void setEndpointName(@NotNull
                                                     String value)

The name of the endpoint.

getVpcSecurityGroupIds

@Stability(value=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(value=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.

getClusterIdentifier

@Stability(value=Stable)
 @Nullable
public String getClusterIdentifier()

The cluster identifier of the cluster associated with the endpoint.

setClusterIdentifier

@Stability(value=Stable)
public void setClusterIdentifier(@Nullable
                                                          String value)

The cluster identifier of the cluster associated with the endpoint.

getResourceOwner

@Stability(value=Stable)
 @Nullable
public String getResourceOwner()

The AWS account ID of the owner of the cluster.

setResourceOwner

@Stability(value=Stable)
public void setResourceOwner(@Nullable
                                                      String value)

The AWS account ID of the owner of the cluster.

getSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getSubnetGroupName()

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

setSubnetGroupName

@Stability(value=Stable)
public void setSubnetGroupName(@Nullable
                                                        String value)

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