com.amazonaws.services.datasync.model

Class CreateLocationS3Request

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.CreateLocationS3Request

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

CreateLocationS3Request

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateLocationS3Request()

Method Summary

Modifier and Type	Method and Description
CreateLocationS3Request	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getAgentArns() If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
String	getS3BucketArn() The ARN of the Amazon S3 bucket.
S3Config	getS3Config()
String	getS3StorageClass() The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
String	getSubdirectory() A subdirectory in the Amazon S3 bucket.
List<TagListEntry>	getTags() The key-value pair that represents the tag that you want to add to the location.
int	hashCode()
void	setAgentArns(Collection<String> agentArns) If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
void	setS3BucketArn(String s3BucketArn) The ARN of the Amazon S3 bucket.
void	setS3Config(S3Config s3Config)
void	setS3StorageClass(String s3StorageClass) The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
void	setSubdirectory(String subdirectory) A subdirectory in the Amazon S3 bucket.
void	setTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the location.
String	toString() Returns a string representation of this object.
CreateLocationS3Request	withAgentArns(Collection<String> agentArns) If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
CreateLocationS3Request	withAgentArns(String... agentArns) If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
CreateLocationS3Request	withS3BucketArn(String s3BucketArn) The ARN of the Amazon S3 bucket.
CreateLocationS3Request	withS3Config(S3Config s3Config)
CreateLocationS3Request	withS3StorageClass(S3StorageClass s3StorageClass) The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
CreateLocationS3Request	withS3StorageClass(String s3StorageClass) The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
CreateLocationS3Request	withSubdirectory(String subdirectory) A subdirectory in the Amazon S3 bucket.
CreateLocationS3Request	withTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to add to the location.
CreateLocationS3Request	withTags(TagListEntry... tags) The key-value pair that represents the tag that you want to add to the location.

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

CreateLocationS3Request

public CreateLocationS3Request()

Method Detail

setSubdirectory

public void setSubdirectory(String subdirectory)

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Parameters:

subdirectory - A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

getSubdirectory

public String getSubdirectory()

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Returns:

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

withSubdirectory

public CreateLocationS3Request withSubdirectory(String subdirectory)

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Parameters:

subdirectory - A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Returns:

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

setS3BucketArn

public void setS3BucketArn(String s3BucketArn)

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Parameters:

s3BucketArn - The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

getS3BucketArn

public String getS3BucketArn()

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Returns:

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

withS3BucketArn

public CreateLocationS3Request withS3BucketArn(String s3BucketArn)

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Parameters:

s3BucketArn - The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Returns:

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

setS3StorageClass

public void setS3StorageClass(String s3StorageClass)

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Parameters:

s3StorageClass - The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

See Also:

S3StorageClass

getS3StorageClass

public String getS3StorageClass()

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Returns:

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

See Also:

S3StorageClass

withS3StorageClass

public CreateLocationS3Request withS3StorageClass(String s3StorageClass)

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Parameters:

s3StorageClass - The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Returns:

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

See Also:

S3StorageClass

withS3StorageClass

public CreateLocationS3Request withS3StorageClass(S3StorageClass s3StorageClass)

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Parameters:

s3StorageClass - The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Returns:

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

See Also:

S3StorageClass

setS3Config

public void setS3Config(S3Config s3Config)

Parameters:

s3Config -

getS3Config

public S3Config getS3Config()

Returns:

withS3Config

public CreateLocationS3Request withS3Config(S3Config s3Config)

Parameters:

s3Config -

Returns:

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

getAgentArns

public List<String> getAgentArns()

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Returns:

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

setAgentArns

public void setAgentArns(Collection<String> agentArns)

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Parameters:

agentArns - If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

withAgentArns

public CreateLocationS3Request withAgentArns(String... agentArns)

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

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

Parameters:

agentArns - If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Returns:

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

withAgentArns

public CreateLocationS3Request withAgentArns(Collection<String> agentArns)

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Parameters:

agentArns - If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Returns:

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

getTags

public List<TagListEntry> getTags()

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Returns:

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

setTags

public void setTags(Collection<TagListEntry> tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

withTags

public CreateLocationS3Request withTags(TagListEntry... tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

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 - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Returns:

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

withTags

public CreateLocationS3Request withTags(Collection<TagListEntry> tags)

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Parameters:

tags - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

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 CreateLocationS3Request 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()