com.amazonaws.services.recyclebin.model

Class CreateRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.recyclebin.model.CreateRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRuleRequest()

Method Summary

Modifier and Type	Method and Description
CreateRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() The retention rule description.
LockConfiguration	getLockConfiguration() Information about the retention rule lock configuration.
List<ResourceTag>	getResourceTags() Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
String	getResourceType() The resource type to be retained by the retention rule.
RetentionPeriod	getRetentionPeriod() Information about the retention period for which the retention rule is to retain resources.
List<Tag>	getTags() Information about the tags to assign to the retention rule.
int	hashCode()
void	setDescription(String description) The retention rule description.
void	setLockConfiguration(LockConfiguration lockConfiguration) Information about the retention rule lock configuration.
void	setResourceTags(Collection<ResourceTag> resourceTags) Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
void	setResourceType(String resourceType) The resource type to be retained by the retention rule.
void	setRetentionPeriod(RetentionPeriod retentionPeriod) Information about the retention period for which the retention rule is to retain resources.
void	setTags(Collection<Tag> tags) Information about the tags to assign to the retention rule.
String	toString() Returns a string representation of this object.
CreateRuleRequest	withDescription(String description) The retention rule description.
CreateRuleRequest	withLockConfiguration(LockConfiguration lockConfiguration) Information about the retention rule lock configuration.
CreateRuleRequest	withResourceTags(Collection<ResourceTag> resourceTags) Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
CreateRuleRequest	withResourceTags(ResourceTag... resourceTags) Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule.
CreateRuleRequest	withResourceType(ResourceType resourceType) The resource type to be retained by the retention rule.
CreateRuleRequest	withResourceType(String resourceType) The resource type to be retained by the retention rule.
CreateRuleRequest	withRetentionPeriod(RetentionPeriod retentionPeriod) Information about the retention period for which the retention rule is to retain resources.
CreateRuleRequest	withTags(Collection<Tag> tags) Information about the tags to assign to the retention rule.
CreateRuleRequest	withTags(Tag... tags) Information about the tags to assign to the retention rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRuleRequest

public CreateRuleRequest()

Method Detail

setRetentionPeriod

public void setRetentionPeriod(RetentionPeriod retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

getRetentionPeriod

public RetentionPeriod getRetentionPeriod()

Information about the retention period for which the retention rule is to retain resources.

Returns:

Information about the retention period for which the retention rule is to retain resources.

withRetentionPeriod

public CreateRuleRequest withRetentionPeriod(RetentionPeriod retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

Returns:

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

setDescription

public void setDescription(String description)

The retention rule description.

Parameters:

description - The retention rule description.

getDescription

public String getDescription()

The retention rule description.

Returns:

The retention rule description.

withDescription

public CreateRuleRequest withDescription(String description)

The retention rule description.

Parameters:

description - The retention rule description.

Returns:

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

getTags

public List<Tag> getTags()

Information about the tags to assign to the retention rule.

Returns:

Information about the tags to assign to the retention rule.

setTags

public void setTags(Collection<Tag> tags)

Information about the tags to assign to the retention rule.

Parameters:

tags - Information about the tags to assign to the retention rule.

withTags

public CreateRuleRequest withTags(Tag... tags)

Information about the tags to assign to the retention rule.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Information about the tags to assign to the retention rule.

Returns:

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

withTags

public CreateRuleRequest withTags(Collection<Tag> tags)

Information about the tags to assign to the retention rule.

Parameters:

tags - Information about the tags to assign to the retention rule.

Returns:

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

setResourceType

public void setResourceType(String resourceType)

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

See Also:

ResourceType

getResourceType

public String getResourceType()

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

See Also:

ResourceType

withResourceType

public CreateRuleRequest withResourceType(String resourceType)

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

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

See Also:

ResourceType

withResourceType

public CreateRuleRequest withResourceType(ResourceType resourceType)

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

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

See Also:

ResourceType

getResourceTags

public List<ResourceTag> getResourceTags()

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

setResourceTags

public void setResourceTags(Collection<ResourceTag> resourceTags)

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

withResourceTags

public CreateRuleRequest withResourceTags(ResourceTag... resourceTags)

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

NOTE: This method appends the values to the existing list (if any). Use setResourceTags(java.util.Collection) or withResourceTags(java.util.Collection) if you want to override the existing values.

Parameters:

resourceTags - Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:

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

withResourceTags

public CreateRuleRequest withResourceTags(Collection<ResourceTag> resourceTags)

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Parameters:

resourceTags - Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

Returns:

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

setLockConfiguration

public void setLockConfiguration(LockConfiguration lockConfiguration)

Information about the retention rule lock configuration.

Parameters:

lockConfiguration - Information about the retention rule lock configuration.

getLockConfiguration

public LockConfiguration getLockConfiguration()

Information about the retention rule lock configuration.

Returns:

Information about the retention rule lock configuration.

withLockConfiguration

public CreateRuleRequest withLockConfiguration(LockConfiguration lockConfiguration)

Information about the retention rule lock configuration.

Parameters:

lockConfiguration - Information about the retention rule lock configuration.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()