software.amazon.awscdk.services.rds

Class CfnDBSecurityGroupIngress

java.lang.Object

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.rds.CfnDBSecurityGroupIngress

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.158Z")
public class CfnDBSecurityGroupIngress
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::DBSecurityGroupIngress`.

The AWS::RDS::DBSecurityGroupIngress resource enables ingress to a DB security group using one of two forms of authorization. First, you can add EC2 or VPC security groups to the DB security group if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet.

This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates .

For details about the settings for DB security group ingress, see AuthorizeDBSecurityGroupIngress .

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide , the blog EC2-Classic Networking is Retiring – Here’s How to Prepare , and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User 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.rds.*;
 CfnDBSecurityGroupIngress cfnDBSecurityGroupIngress = CfnDBSecurityGroupIngress.Builder.create(this, "MyCfnDBSecurityGroupIngress")
         .dbSecurityGroupName("dbSecurityGroupName")
         // the properties below are optional
         .cidrip("cidrip")
         .ec2SecurityGroupId("ec2SecurityGroupId")
         .ec2SecurityGroupName("ec2SecurityGroupName")
         .ec2SecurityGroupOwnerId("ec2SecurityGroupOwnerId")
         .build();
 

Nested Class Summary

Nested Classes

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

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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBSecurityGroupIngress(Construct scope, java.lang.String id, CfnDBSecurityGroupIngressProps props) Create a new `AWS::RDS::DBSecurityGroupIngress`.
protected	CfnDBSecurityGroupIngress(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBSecurityGroupIngress(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCidrip() The IP range to authorize.
java.lang.String	getDbSecurityGroupName() The name of the DB security group to add authorization to.
java.lang.String	getEc2SecurityGroupId() Id of the EC2 security group to authorize.
java.lang.String	getEc2SecurityGroupName() Name of the EC2 security group to authorize.
java.lang.String	getEc2SecurityGroupOwnerId() AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCidrip(java.lang.String value) The IP range to authorize.
void	setDbSecurityGroupName(java.lang.String value) The name of the DB security group to add authorization to.
void	setEc2SecurityGroupId(java.lang.String value) Id of the EC2 security group to authorize.
void	setEc2SecurityGroupName(java.lang.String value) Name of the EC2 security group to authorize.
void	setEc2SecurityGroupOwnerId(java.lang.String value) AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter.

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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBSecurityGroupIngress

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

CfnDBSecurityGroupIngress

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

CfnDBSecurityGroupIngress

public CfnDBSecurityGroupIngress(Construct scope,
                                 java.lang.String id,
                                 CfnDBSecurityGroupIngressProps props)

Create a new `AWS::RDS::DBSecurityGroupIngress`.

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDbSecurityGroupName

public java.lang.String getDbSecurityGroupName()

The name of the DB security group to add authorization to.

setDbSecurityGroupName

public void setDbSecurityGroupName(java.lang.String value)

The name of the DB security group to add authorization to.

getCidrip

public java.lang.String getCidrip()

The IP range to authorize.

setCidrip

public void setCidrip(java.lang.String value)

The IP range to authorize.

getEc2SecurityGroupId

public java.lang.String getEc2SecurityGroupId()

Id of the EC2 security group to authorize.

For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

setEc2SecurityGroupId

public void setEc2SecurityGroupId(java.lang.String value)

Id of the EC2 security group to authorize.

For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

getEc2SecurityGroupName

public java.lang.String getEc2SecurityGroupName()

Name of the EC2 security group to authorize.

For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

setEc2SecurityGroupName

public void setEc2SecurityGroupName(java.lang.String value)

Name of the EC2 security group to authorize.

For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

getEc2SecurityGroupOwnerId

public java.lang.String getEc2SecurityGroupOwnerId()

AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter.

The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

setEc2SecurityGroupOwnerId

public void setEc2SecurityGroupOwnerId(java.lang.String value)

AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter.

The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.