org.jclouds.rds.features

Interface SecurityGroupApi

public interface SecurityGroupApi

Provides access to Amazon RDS via the Query API

Author:

Adrian Cole

See Also:

doc, SecurityGroupAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
SecurityGroup	authorizeIngressToEC2SecurityGroupOfOwner(String name, String ec2SecurityGroupName, String ec2SecurityGroupOwnerId) Enables ingress to a DBSecurityGroup if the application using the database is running on EC2 instances.
SecurityGroup	authorizeIngressToIPRange(String name, String CIDR) Enables ingress to a DBSecurityGroup to an IP range, if the application accessing your database is running on the Internet.
SecurityGroup	authorizeIngressToVPCSecurityGroup(String name, String vpcSecurityGroupId) Enables ingress to a DBSecurityGroup if the application using the database is running on VPC instances.
SecurityGroup	createInVPCWithNameAndDescription(String vpcId, String name, String description) Creates a new DB Security Group.
SecurityGroup	createWithNameAndDescription(String name, String description) Creates a new DB Security Group.
void	delete(String name) Deletes a DB security group.
SecurityGroup	get(String name) Retrieves information about the specified SecurityGroup.
PagedIterable<SecurityGroup>	list() Returns a list of SecurityGroups.
IterableWithMarker<SecurityGroup>	list(ListSecurityGroupsOptions options) Returns a list of SecurityGroups.
SecurityGroup	revokeIngressFromEC2SecurityGroupOfOwner(String name, String ec2SecurityGroupName, String ec2SecurityGroupOwnerId) Revokes ingress from a DBSecurityGroup for previously authorized EC2 Security Group.
SecurityGroup	revokeIngressFromIPRange(String name, String CIDR) Revokes ingress from a DBSecurityGroup for previously authorized IP range.
SecurityGroup	revokeIngressFromVPCSecurityGroup(String name, String vpcSecurityGroupId) Revokes ingress from a DBSecurityGroup for previously authorized VPC Security Group.

Method Detail

createWithNameAndDescription

SecurityGroup createWithNameAndDescription(String name,
                                         String description)

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

Parameters:

name - The name for the DB Security Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

description - The description for the DB Security Group.

Returns:

the new security group

createInVPCWithNameAndDescription

SecurityGroup createInVPCWithNameAndDescription(String vpcId,
                                              String name,
                                              String description)

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

Parameters:

vpcId - The Id of VPC. Indicates which VPC this DB Security Group should belong to. Must be specified to create a DB Security Group for a VPC; may not be specified otherwise.

name - The name for the DB Security Group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

description - The description for the DB Security Group.

Returns:

the new security group

get

@Nullable
SecurityGroup get(String name)

Retrieves information about the specified SecurityGroup.

Parameters:

name - Name of the security group to get information about.

Returns:

null if not found

list

IterableWithMarker<SecurityGroup> list(ListSecurityGroupsOptions options)

Returns a list of SecurityGroups.
You can paginate the results using the parameter

Parameters:

options - the options describing the security groups query

Returns:

the response object

list

PagedIterable<SecurityGroup> list()

Returns a list of SecurityGroups.

Returns:

the response object

authorizeIngressToIPRange

SecurityGroup authorizeIngressToIPRange(String name,
                                      String CIDR)

Enables ingress to a DBSecurityGroup to an IP range, if the application accessing your database is running on the Internet.

Parameters:

name - The name of the DB Security Group to add authorization to.

CIDR - The IP range to authorize.

Returns:

updated security group, noting the authorization status may not be complete

authorizeIngressToEC2SecurityGroupOfOwner

SecurityGroup authorizeIngressToEC2SecurityGroupOfOwner(String name,
                                                      String ec2SecurityGroupName,
                                                      String ec2SecurityGroupOwnerId)

Enables ingress to a DBSecurityGroup if the application using the database is running on EC2 instances.

Note

You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another.

Parameters:

name - The name of the DB Security Group to add authorization to.

ec2SecurityGroupName - Name of the EC2 Security Group to authorize.

ec2SecurityGroupOwnerId - AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Returns:

updated security group, noting the authorization status may not be complete

authorizeIngressToVPCSecurityGroup

SecurityGroup authorizeIngressToVPCSecurityGroup(String name,
                                               String vpcSecurityGroupId)

Enables ingress to a DBSecurityGroup if the application using the database is running on VPC instances.

Note

You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB Instance in another.

Parameters:

name - The name of the DB Security Group to add authorization to.

vpcSecurityGroupId - Id of the EC2 Security Group to authorize.

Returns:

updated security group, noting the authorization status may not be complete

revokeIngressFromIPRange

SecurityGroup revokeIngressFromIPRange(String name,
                                     String CIDR)

Revokes ingress from a DBSecurityGroup for previously authorized IP range.

Parameters:

name - The name of the DB Security Group to revoke ingress from.

CIDR - The IP range to revoke.

Returns:

updated security group, noting the authorization status may not be complete

revokeIngressFromEC2SecurityGroupOfOwner

SecurityGroup revokeIngressFromEC2SecurityGroupOfOwner(String name,
                                                     String ec2SecurityGroupName,
                                                     String ec2SecurityGroupOwnerId)

Revokes ingress from a DBSecurityGroup for previously authorized EC2 Security Group.

Parameters:

name - The name of the DB Security Group to revoke ingress from.

ec2SecurityGroupName - Name of the EC2 Security Group to revoke.

ec2SecurityGroupOwnerId - AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Returns:

updated security group, noting the authorization status may not be complete

revokeIngressFromVPCSecurityGroup

SecurityGroup revokeIngressFromVPCSecurityGroup(String name,
                                              String vpcSecurityGroupId)

Revokes ingress from a DBSecurityGroup for previously authorized VPC Security Group.

Parameters:

name - The name of the DB Security Group to revoke ingress from.

vpcSecurityGroupId - Id of the EC2 Security Group to revoke.

Returns:

updated security group, noting the authorization status may not be complete

delete

void delete(String name)

Deletes a DB security group.

Naming Constraints

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

name - The name of the database security group to delete.

Note

You cannot delete the default security group.