com.amazonaws.services.rds.model

Class AuthorizeDBSecurityGroupIngressRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.AuthorizeDBSecurityGroupIngressRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class AuthorizeDBSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the AuthorizeDBSecurityGroupIngress operation.

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 cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot 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:

AmazonRDS.authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AuthorizeDBSecurityGroupIngressRequest() Default constructor for a new AuthorizeDBSecurityGroupIngressRequest object.
AuthorizeDBSecurityGroupIngressRequest(String dBSecurityGroupName) Constructs a new AuthorizeDBSecurityGroupIngressRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizeDBSecurityGroupIngressRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCIDRIP() The IP range to authorize.
String	getDBSecurityGroupName() The name of the DB security group to add authorization to.
String	getEC2SecurityGroupId() Id of the EC2 security group to authorize.
String	getEC2SecurityGroupName() Name of the EC2 security group to authorize.
String	getEC2SecurityGroupOwnerId() AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter.
int	hashCode()
void	setCIDRIP(String cIDRIP) The IP range to authorize.
void	setDBSecurityGroupName(String dBSecurityGroupName) The name of the DB security group to add authorization to.
void	setEC2SecurityGroupId(String eC2SecurityGroupId) Id of the EC2 security group to authorize.
void	setEC2SecurityGroupName(String eC2SecurityGroupName) Name of the EC2 security group to authorize.
void	setEC2SecurityGroupOwnerId(String eC2SecurityGroupOwnerId) AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AuthorizeDBSecurityGroupIngressRequest	withCIDRIP(String cIDRIP) The IP range to authorize.
AuthorizeDBSecurityGroupIngressRequest	withDBSecurityGroupName(String dBSecurityGroupName) The name of the DB security group to add authorization to.
AuthorizeDBSecurityGroupIngressRequest	withEC2SecurityGroupId(String eC2SecurityGroupId) Id of the EC2 security group to authorize.
AuthorizeDBSecurityGroupIngressRequest	withEC2SecurityGroupName(String eC2SecurityGroupName) Name of the EC2 security group to authorize.
AuthorizeDBSecurityGroupIngressRequest	withEC2SecurityGroupOwnerId(String eC2SecurityGroupOwnerId) AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthorizeDBSecurityGroupIngressRequest

public AuthorizeDBSecurityGroupIngressRequest()

Default constructor for a new AuthorizeDBSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

AuthorizeDBSecurityGroupIngressRequest

public AuthorizeDBSecurityGroupIngressRequest(String dBSecurityGroupName)

Constructs a new AuthorizeDBSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

Method Detail

getDBSecurityGroupName

public String getDBSecurityGroupName()

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

Returns:

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

setDBSecurityGroupName

public void setDBSecurityGroupName(String dBSecurityGroupName)

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

Parameters:

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

withDBSecurityGroupName

public AuthorizeDBSecurityGroupIngressRequest withDBSecurityGroupName(String dBSecurityGroupName)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCIDRIP

public String getCIDRIP()

The IP range to authorize.

Returns:

The IP range to authorize.

setCIDRIP

public void setCIDRIP(String cIDRIP)

The IP range to authorize.

Parameters:

cIDRIP - The IP range to authorize.

withCIDRIP

public AuthorizeDBSecurityGroupIngressRequest withCIDRIP(String cIDRIP)

The IP range to authorize.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cIDRIP - The IP range to authorize.

Returns:

A reference to this updated object so that method calls can be chained together.

getEC2SecurityGroupName

public String getEC2SecurityGroupName()

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.

Returns:

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.

setEC2SecurityGroupName

public void setEC2SecurityGroupName(String eC2SecurityGroupName)

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.

Parameters:

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

withEC2SecurityGroupName

public AuthorizeDBSecurityGroupIngressRequest withEC2SecurityGroupName(String eC2SecurityGroupName)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getEC2SecurityGroupId

public String getEC2SecurityGroupId()

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.

Returns:

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.

setEC2SecurityGroupId

public void setEC2SecurityGroupId(String eC2SecurityGroupId)

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.

Parameters:

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

withEC2SecurityGroupId

public AuthorizeDBSecurityGroupIngressRequest withEC2SecurityGroupId(String eC2SecurityGroupId)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getEC2SecurityGroupOwnerId

public String getEC2SecurityGroupOwnerId()

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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Returns:

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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

setEC2SecurityGroupOwnerId

public void setEC2SecurityGroupOwnerId(String 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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Parameters:

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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

withEC2SecurityGroupOwnerId

public AuthorizeDBSecurityGroupIngressRequest withEC2SecurityGroupOwnerId(String 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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public AuthorizeDBSecurityGroupIngressRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()