[ aws . rds ]

authorize-db-security-group-ingress

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).

Note

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  authorize-db-security-group-ingress
--db-security-group-name <value>
[--cidrip <value>]
[--ec2-security-group-name <value>]
[--ec2-security-group-id <value>]
[--ec2-security-group-owner-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-security-group-name (string)

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

--cidrip (string)

The IP range to authorize.

--ec2-security-group-name (string)

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-id (string)

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-owner-id (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To associate an AWS Identity and Access Management (IAM) role with a DB instance

The following authorize-db-security-group-ingress example configures the default security group with an ingress rule for the CIDR IP range 192.0.2.0/24.

aws rds authorize-db-security-group-ingress \
    --db-security-group-name default \
    --cidrip 192.0.2.0/24

Output:

{
    "DBSecurityGroup": {
        "OwnerId": "123456789012",
        "DBSecurityGroupName": "default",
        "DBSecurityGroupDescription": "default",
        "EC2SecurityGroups": [],
        "IPRanges": [
            {
                "Status": "authorizing",
                "CIDRIP": "192.0.2.0/24"
            }
        ],
        "DBSecurityGroupArn": "arn:aws:rds:us-east-1:111122223333:secgrp:default"
    }
}

For more information, see Authorizing Network Access to a DB Security Group from an IP Range in the Amazon RDS User Guide.

Output

DBSecurityGroup -> (structure)

Contains the details for an Amazon RDS DB security group.

This data type is used as a response element in the DescribeDBSecurityGroups action.

OwnerId -> (string)

Provides the Amazon Web Services ID of the owner of a specific DB security group.

DBSecurityGroupName -> (string)

Specifies the name of the DB security group.

DBSecurityGroupDescription -> (string)

Provides the description of the DB security group.

VpcId -> (string)

Provides the VpcId of the DB security group.

EC2SecurityGroups -> (list)

Contains a list of EC2SecurityGroup elements.

(structure)

This data type is used as a response element in the following actions:

• AuthorizeDBSecurityGroupIngress

• DescribeDBSecurityGroups

• RevokeDBSecurityGroupIngress

Status -> (string)

Provides the status of the EC2 security group. Status can be “authorizing”, “authorized”, “revoking”, and “revoked”.

EC2SecurityGroupName -> (string)

Specifies the name of the EC2 security group.

EC2SecurityGroupId -> (string)

Specifies the id of the EC2 security group.

EC2SecurityGroupOwnerId -> (string)

Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

IPRanges -> (list)

Contains a list of IPRange elements.

(structure)

This data type is used as a response element in the DescribeDBSecurityGroups action.

Status -> (string)

Specifies the status of the IP range. Status can be “authorizing”, “authorized”, “revoking”, and “revoked”.

CIDRIP -> (string)

Specifies the IP range.

DBSecurityGroupArn -> (string)

The Amazon Resource Name (ARN) for the DB security group.