S3Settings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.S3Settings

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3Settings()

Constructors
Constructor and Description
`S3Settings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Settings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBucketFolder()` An optional parameter to set a folder name in the S3 bucket.
`String`	`getBucketName()` The name of the S3 bucket.
`String`	`getCompressionType()` An optional parameter to use GZIP to compress the target files.
`String`	`getCsvDelimiter()` The delimiter used to separate columns in the source files.
`String`	`getCsvRowDelimiter()` The delimiter used to separate rows in the source files.
`String`	`getExternalTableDefinition()`
`String`	`getServiceAccessRoleArn()` The Amazon Resource Name (ARN) used by the service access IAM role.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBucketFolder(String bucketFolder)` An optional parameter to set a folder name in the S3 bucket.
`void`	`setBucketName(String bucketName)` The name of the S3 bucket.
`void`	`setCompressionType(CompressionTypeValue compressionType)` An optional parameter to use GZIP to compress the target files.
`void`	`setCompressionType(String compressionType)` An optional parameter to use GZIP to compress the target files.
`void`	`setCsvDelimiter(String csvDelimiter)` The delimiter used to separate columns in the source files.
`void`	`setCsvRowDelimiter(String csvRowDelimiter)` The delimiter used to separate rows in the source files.
`void`	`setExternalTableDefinition(String externalTableDefinition)`
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) used by the service access IAM role.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`S3Settings`	`withBucketFolder(String bucketFolder)` An optional parameter to set a folder name in the S3 bucket.
`S3Settings`	`withBucketName(String bucketName)` The name of the S3 bucket.
`S3Settings`	`withCompressionType(CompressionTypeValue compressionType)` An optional parameter to use GZIP to compress the target files.
`S3Settings`	`withCompressionType(String compressionType)` An optional parameter to use GZIP to compress the target files.
`S3Settings`	`withCsvDelimiter(String csvDelimiter)` The delimiter used to separate columns in the source files.
`S3Settings`	`withCsvRowDelimiter(String csvRowDelimiter)` The delimiter used to separate rows in the source files.
`S3Settings`	`withExternalTableDefinition(String externalTableDefinition)`
`S3Settings`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) used by the service access IAM role.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - S3Settings
```
public S3Settings()
```
- Method Detail
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Returns:
    
    The Amazon Resource Name (ARN) used by the service access IAM role.
  - withServiceAccessRoleArn
```
public S3Settings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExternalTableDefinition
```
public void setExternalTableDefinition(String externalTableDefinition)
```
    Parameters:
    
    externalTableDefinition -
  - getExternalTableDefinition
```
public String getExternalTableDefinition()
```
    Returns:
  - withExternalTableDefinition
```
public S3Settings withExternalTableDefinition(String externalTableDefinition)
```
    Parameters:
    
    externalTableDefinition -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCsvRowDelimiter
```
public void setCsvRowDelimiter(String csvRowDelimiter)
```
    The delimiter used to separate rows in the source files. The default is a carriage return (\n).
    
    Parameters:
    
    csvRowDelimiter - The delimiter used to separate rows in the source files. The default is a carriage return (\n).
  - getCsvRowDelimiter
```
public String getCsvRowDelimiter()
```
    The delimiter used to separate rows in the source files. The default is a carriage return (\n).
    
    Returns:
    
    The delimiter used to separate rows in the source files. The default is a carriage return (\n).
  - withCsvRowDelimiter
```
public S3Settings withCsvRowDelimiter(String csvRowDelimiter)
```
    The delimiter used to separate rows in the source files. The default is a carriage return (\n).
    
    Parameters:
    
    csvRowDelimiter - The delimiter used to separate rows in the source files. The default is a carriage return (\n).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCsvDelimiter
```
public void setCsvDelimiter(String csvDelimiter)
```
    The delimiter used to separate columns in the source files. The default is a comma.
    
    Parameters:
    
    csvDelimiter - The delimiter used to separate columns in the source files. The default is a comma.
  - getCsvDelimiter
```
public String getCsvDelimiter()
```
    The delimiter used to separate columns in the source files. The default is a comma.
    
    Returns:
    
    The delimiter used to separate columns in the source files. The default is a comma.
  - withCsvDelimiter
```
public S3Settings withCsvDelimiter(String csvDelimiter)
```
    The delimiter used to separate columns in the source files. The default is a comma.
    
    Parameters:
    
    csvDelimiter - The delimiter used to separate columns in the source files. The default is a comma.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketFolder
```
public void setBucketFolder(String bucketFolder)
```
    An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    
    Parameters:
    
    bucketFolder - An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
  - getBucketFolder
```
public String getBucketFolder()
```
    An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    
    Returns:
    
    An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
  - withBucketFolder
```
public S3Settings withBucketFolder(String bucketFolder)
```
    An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    
    Parameters:
    
    bucketFolder - An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketName
```
public void setBucketName(String bucketName)
```
    The name of the S3 bucket.
    
    Parameters:
    
    bucketName - The name of the S3 bucket.
  - getBucketName
```
public String getBucketName()
```
    The name of the S3 bucket.
    
    Returns:
    
    The name of the S3 bucket.
  - withBucketName
```
public S3Settings withBucketName(String bucketName)
```
    The name of the S3 bucket.
    
    Parameters:
    
    bucketName - The name of the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompressionType
```
public void setCompressionType(String compressionType)
```
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Parameters:
    
    compressionType - An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    See Also:
    
    CompressionTypeValue
  - getCompressionType
```
public String getCompressionType()
```
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Returns:
    
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    See Also:
    
    CompressionTypeValue
  - withCompressionType
```
public S3Settings withCompressionType(String compressionType)
```
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Parameters:
    
    compressionType - An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionTypeValue
  - setCompressionType
```
public void setCompressionType(CompressionTypeValue compressionType)
```
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Parameters:
    
    compressionType - An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    See Also:
    
    CompressionTypeValue
  - withCompressionType
```
public S3Settings withCompressionType(CompressionTypeValue compressionType)
```
    An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Parameters:
    
    compressionType - An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionTypeValue
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public S3Settings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class S3Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Settings

Method Detail

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setExternalTableDefinition

getExternalTableDefinition

withExternalTableDefinition

setCsvRowDelimiter

getCsvRowDelimiter

withCsvRowDelimiter

setCsvDelimiter

getCsvDelimiter

withCsvDelimiter

setBucketFolder

getBucketFolder

withBucketFolder

setBucketName

getBucketName

withBucketName

setCompressionType

getCompressionType

withCompressionType

setCompressionType

withCompressionType

toString

equals

hashCode

clone

marshall