authorize_db_security_group_ingress¶
Operation¶
authorize_db_security_group_ingress
async
¶
authorize_db_security_group_ingress(request: AuthorizeDBSecurityGroupIngressInput | AuthorizeDBSecurityGroupIngressInputDict, /, *, plugins: list[Plugin] | None = None) -> AuthorizeDBSecurityGroupIngressOutput
authorize_db_security_group_ingress(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AuthorizeDBSecurityGroupIngressInputDict]) -> AuthorizeDBSecurityGroupIngressOutput
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.
Note
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
AuthorizeDBSecurityGroupIngressOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
AuthorizeDBSecurityGroupIngressInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_security_group_name
class-attribute
instance-attribute
¶
db_security_group_name: str | None = ...
The name of the DB security group to add authorization to.
ec2_security_group_id
class-attribute
instance-attribute
¶
ec2_security_group_id: str | None = ...
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.
ec2_security_group_name
class-attribute
instance-attribute
¶
ec2_security_group_name: str | None = ...
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.
ec2_security_group_owner_id
class-attribute
instance-attribute
¶
ec2_security_group_owner_id: str | None = ...
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 either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
Dictionaries¶
AuthorizeDBSecurityGroupIngressInputDict
¶
Bases: TypedDict
Dictionary form of AuthorizeDBSecurityGroupIngressInput.
Attributes¶
db_security_group_name
instance-attribute
¶
The name of the DB security group to add authorization to.
ec2_security_group_id
instance-attribute
¶
ec2_security_group_id: str | None
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.
ec2_security_group_name
instance-attribute
¶
ec2_security_group_name: str | None
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.
ec2_security_group_owner_id
instance-attribute
¶
ec2_security_group_owner_id: str | None
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 either EC2SecurityGroupName or
EC2SecurityGroupId must be provided.
Output¶
AuthorizeDBSecurityGroupIngressOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for AuthorizeDBSecurityGroupIngressOutput structure.
Attributes¶
db_security_group
class-attribute
instance-attribute
¶
db_security_group: DBSecurityGroup | None = ...
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups action.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.