software.amazon.awssdk.services.datasync.model

Class CreateLocationS3Request

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateLocationS3Request

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLocationS3Request
extends DataSyncRequest
implements ToCopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>

CreateLocationS3Request

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLocationS3Request.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentArns() If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
static CreateLocationS3Request.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	s3BucketArn() The ARN of the Amazon S3 bucket.
S3Config	s3Config() Returns the value of the S3Config property for this object.
S3StorageClass	s3StorageClass() The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
String	s3StorageClassAsString() The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLocationS3Request.Builder>	serializableBuilderClass()
String	subdirectory() A subdirectory in the Amazon S3 bucket.
List<TagListEntry>	tags() The key-value pair that represents the tag that you want to add to the location.
CreateLocationS3Request.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

subdirectory

public final 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.

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.

s3BucketArn

public final String s3BucketArn()

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

Returns:

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

s3StorageClass

public final 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 AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS 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 using-storage-classes.

If the service returns an enum value that is not available in the current SDK version, s3StorageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3StorageClassAsString().

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 AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS 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 using-storage-classes.

See Also:

S3StorageClass

s3StorageClassAsString

public final String s3StorageClassAsString()

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 AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS 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 using-storage-classes.

If the service returns an enum value that is not available in the current SDK version, s3StorageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3StorageClassAsString().

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 AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS 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 using-storage-classes.

See Also:

S3StorageClass

s3Config

public final S3Config s3Config()

Returns the value of the S3Config property for this object.

Returns:

The value of the S3Config property for this object.

hasAgentArns

public final boolean hasAgentArns()

Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

agentArns

public final List<String> agentArns()

If you are using DataSync on an AWS 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 AWS Outpost, see outposts-agent.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAgentArns() to see if a value was sent in this field.

Returns:

If you are using DataSync on an AWS 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 AWS Outpost, see outposts-agent.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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.

toBuilder

public CreateLocationS3Request.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>

Specified by:

toBuilder in class DataSyncRequest

builder

public static CreateLocationS3Request.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLocationS3Request.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo