Class CfnDBSecurityGroupIngress
A CloudFormation AWS::RDS::DBSecurityGroupIngress
.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnDBSecurityGroupIngress : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBSecurityGroupIngress
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::RDS::DBSecurityGroupIngress
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnDBSecurityGroupIngress = new CfnDBSecurityGroupIngress(this, "MyCfnDBSecurityGroupIngress", new CfnDBSecurityGroupIngressProps {
DbSecurityGroupName = "dbSecurityGroupName",
// the properties below are optional
Cidrip = "cidrip",
Ec2SecurityGroupId = "ec2SecurityGroupId",
Ec2SecurityGroupName = "ec2SecurityGroupName",
Ec2SecurityGroupOwnerId = "ec2SecurityGroupOwnerId"
});
Synopsis
Constructors
CfnDBSecurityGroupIngress(Construct, String, ICfnDBSecurityGroupIngressProps) | Create a new |
CfnDBSecurityGroupIngress(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDBSecurityGroupIngress(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Cidrip | The IP range to authorize. |
DbSecurityGroupName | The name of the DB security group to add authorization to. |
Ec2SecurityGroupId | Id of the EC2 security group to authorize. |
Ec2SecurityGroupName | Name of the EC2 security group to authorize. |
Ec2SecurityGroupOwnerId | AWS account number of the owner of the EC2 security group specified in the |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDBSecurityGroupIngress(Construct, String, ICfnDBSecurityGroupIngressProps)
Create a new AWS::RDS::DBSecurityGroupIngress
.
public CfnDBSecurityGroupIngress(Construct scope, string id, ICfnDBSecurityGroupIngressProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDBSecurityGroupIngressProps
- resource properties.
CfnDBSecurityGroupIngress(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDBSecurityGroupIngress(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDBSecurityGroupIngress(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDBSecurityGroupIngress(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Cidrip
The IP range to authorize.
public virtual string Cidrip { get; set; }
Property Value
System.String
Remarks
DbSecurityGroupName
The name of the DB security group to add authorization to.
public virtual string DbSecurityGroupName { get; set; }
Property Value
System.String
Remarks
Ec2SecurityGroupId
Id of the EC2 security group to authorize.
public virtual string Ec2SecurityGroupId { get; set; }
Property Value
System.String
Remarks
For VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId
and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.
Ec2SecurityGroupName
Name of the EC2 security group to authorize.
public virtual string Ec2SecurityGroupName { get; set; }
Property Value
System.String
Remarks
For VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId
and either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.
Ec2SecurityGroupOwnerId
AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName
parameter.
public virtual string Ec2SecurityGroupOwnerId { get; set; }
Property Value
System.String
Remarks
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>