software.amazon.awscdk.services.redshift

Class CfnClusterSecurityGroupIngress

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.CfnClusterSecurityGroupIngress

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:50.075Z")
 @Stability(value=Stable)
public class CfnClusterSecurityGroupIngress
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Redshift::ClusterSecurityGroupIngress`.

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId . The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region .

If you authorize access to a CIDR/IP address range, specify CIDRIP . For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing .

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide .

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.*;
 CfnClusterSecurityGroupIngress cfnClusterSecurityGroupIngress = CfnClusterSecurityGroupIngress.Builder.create(this, "MyCfnClusterSecurityGroupIngress")
         .clusterSecurityGroupName("clusterSecurityGroupName")
         // the properties below are optional
         .cidrip("cidrip")
         .ec2SecurityGroupName("ec2SecurityGroupName")
         .ec2SecurityGroupOwnerId("ec2SecurityGroupOwnerId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnClusterSecurityGroupIngress.Builder A fluent builder for CfnClusterSecurityGroupIngress.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.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
	CfnClusterSecurityGroupIngress(software.constructs.Construct scope, String id, CfnClusterSecurityGroupIngressProps props) Create a new `AWS::Redshift::ClusterSecurityGroupIngress`.
protected	CfnClusterSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getCidrip() The IP range to be added the Amazon Redshift security group.
String	getClusterSecurityGroupName() The name of the security group to which the ingress rule is added.
String	getEc2SecurityGroupName() The EC2 security group to be added the Amazon Redshift security group.
String	getEc2SecurityGroupOwnerId() The AWS account number of the owner of the security group specified by the *EC2SecurityGroupName* parameter.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCidrip(String value) The IP range to be added the Amazon Redshift security group.
void	setClusterSecurityGroupName(String value) The name of the security group to which the ingress rule is added.
void	setEc2SecurityGroupName(String value) The EC2 security group to be added the Amazon Redshift security group.
void	setEc2SecurityGroupOwnerId(String value) The AWS account number of the owner of the security group specified by the *EC2SecurityGroupName* parameter.

Methods inherited from class software.amazon.awscdk.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.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 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

CfnClusterSecurityGroupIngress

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

CfnClusterSecurityGroupIngress

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

CfnClusterSecurityGroupIngress

@Stability(value=Stable)
public CfnClusterSecurityGroupIngress(@NotNull
                                                               software.constructs.Construct scope,
                                                               @NotNull
                                                               String id,
                                                               @NotNull
                                                               CfnClusterSecurityGroupIngressProps props)

Create a new `AWS::Redshift::ClusterSecurityGroupIngress`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getClusterSecurityGroupName

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

The name of the security group to which the ingress rule is added.

setClusterSecurityGroupName

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

The name of the security group to which the ingress rule is added.

getCidrip

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

The IP range to be added the Amazon Redshift security group.

setCidrip

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

The IP range to be added the Amazon Redshift security group.

getEc2SecurityGroupName

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

The EC2 security group to be added the Amazon Redshift security group.

setEc2SecurityGroupName

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

The EC2 security group to be added the Amazon Redshift security group.

getEc2SecurityGroupOwnerId

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

The AWS account number of the owner of the security group specified by the *EC2SecurityGroupName* parameter.

The AWS Access Key ID is not an acceptable value.

Example: 111122223333

Conditional. If you specify the EC2SecurityGroupName property, you must specify this property.

setEc2SecurityGroupOwnerId

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

The AWS account number of the owner of the security group specified by the *EC2SecurityGroupName* parameter.

The AWS Access Key ID is not an acceptable value.

Example: 111122223333

Conditional. If you specify the EC2SecurityGroupName property, you must specify this property.