Authorize Db Security Group Ingress
rds_authorize_db_security_group_ingress | R Documentation |
Enables ingress to a DBSecurityGroup using one of two forms of authorization¶
Description¶
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup 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. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
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.
Usage¶
rds_authorize_db_security_group_ingress(DBSecurityGroupName, CIDRIP,
EC2SecurityGroupName, EC2SecurityGroupId, EC2SecurityGroupOwnerId)
Arguments¶
DBSecurityGroupName
[required] The name of the DB security group to add authorization to.
CIDRIP
The IP range to authorize.
EC2SecurityGroupName
Name of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.EC2SecurityGroupId
Id of the EC2 security group to authorize. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.EC2SecurityGroupOwnerId
Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups,EC2SecurityGroupId
must be provided. Otherwise,EC2SecurityGroupOwnerId
and eitherEC2SecurityGroupName
orEC2SecurityGroupId
must be provided.
Value¶
A list with the following syntax:
list(
DBSecurityGroup = list(
OwnerId = "string",
DBSecurityGroupName = "string",
DBSecurityGroupDescription = "string",
VpcId = "string",
EC2SecurityGroups = list(
list(
Status = "string",
EC2SecurityGroupName = "string",
EC2SecurityGroupId = "string",
EC2SecurityGroupOwnerId = "string"
)
),
IPRanges = list(
list(
Status = "string",
CIDRIP = "string"
)
),
DBSecurityGroupArn = "string"
)
)