software.amazon.awscdk.services.rds

Class CfnDBSecurityGroup

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.421Z")
 @Stability(value=Stable)
public class CfnDBSecurityGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::DBSecurityGroup`.

The AWS::RDS::DBSecurityGroup resource creates or updates an Amazon RDS DB security group.

DB security groups are a part of the EC2-Classic Platform and as such are not supported in all regions. It is advised to use the AWS::EC2::SecurityGroup resource in those regions instead. To determine which platform you are on, see Determining Whether You Are Using the EC2-VPC or EC2-Classic Platform . For more information on the AWS::EC2::SecurityGroup , see the documentation for EC2 security groups .

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.*;
 CfnDBSecurityGroup cfnDBSecurityGroup = CfnDBSecurityGroup.Builder.create(this, "MyCfnDBSecurityGroup")
         .dbSecurityGroupIngress(List.of(IngressProperty.builder()
                 .cidrip("cidrip")
                 .ec2SecurityGroupId("ec2SecurityGroupId")
                 .ec2SecurityGroupName("ec2SecurityGroupName")
                 .ec2SecurityGroupOwnerId("ec2SecurityGroupOwnerId")
                 .build()))
         .groupDescription("groupDescription")
         // the properties below are optional
         .ec2VpcId("ec2VpcId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDBSecurityGroup.Builder A fluent builder for CfnDBSecurityGroup.
static interface	CfnDBSecurityGroup.IngressProperty The `Ingress` property type specifies an individual ingress rule within an `AWS::RDS::DBSecurityGroup` resource.

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

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDbSecurityGroupIngress() Ingress rules to be applied to the DB security group.
String	getEc2VpcId() The identifier of an Amazon VPC.
String	getGroupDescription() Provides the description of the DB security group.
TagManager	getTags() Tags to assign to the DB security group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDbSecurityGroupIngress(IResolvable value) Ingress rules to be applied to the DB security group.
void	setDbSecurityGroupIngress(List<Object> value) Ingress rules to be applied to the DB security group.
void	setEc2VpcId(String value) The identifier of an Amazon VPC.
void	setGroupDescription(String value) Provides the description of the DB security group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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

CfnDBSecurityGroup

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

CfnDBSecurityGroup

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

CfnDBSecurityGroup

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

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

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Tags to assign to the DB security group.

getDbSecurityGroupIngress

@Stability(value=Stable)
 @NotNull
public Object getDbSecurityGroupIngress()

Ingress rules to be applied to the DB security group.

setDbSecurityGroupIngress

@Stability(value=Stable)
public void setDbSecurityGroupIngress(@NotNull
                                                               IResolvable value)

Ingress rules to be applied to the DB security group.

setDbSecurityGroupIngress

@Stability(value=Stable)
public void setDbSecurityGroupIngress(@NotNull
                                                               List<Object> value)

Ingress rules to be applied to the DB security group.

getGroupDescription

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

Provides the description of the DB security group.

setGroupDescription

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

Provides the description of the DB security group.

getEc2VpcId

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

The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to.

The EC2VpcId property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance.

setEc2VpcId

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

The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to.

The EC2VpcId property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance.