com.amazonaws.services.forecast.model

Class S3Config

java.lang.Object

com.amazonaws.services.forecast.model.S3Config

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3Config()

Method Summary

Modifier and Type	Method and Description
S3Config	clone()
boolean	equals(Object obj)
String	getKMSKeyArn() The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
String	getPath() The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
String	getRoleArn() The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKMSKeyArn(String kMSKeyArn) The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
void	setPath(String path) The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
void	setRoleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files.
String	toString() Returns a string representation of this object.
S3Config	withKMSKeyArn(String kMSKeyArn) The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
S3Config	withPath(String path) The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
S3Config	withRoleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

S3Config

public S3Config()

Method Detail

setPath

public void setPath(String path)

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Parameters:

path - The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

getPath

public String getPath()

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Returns:

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

withPath

public S3Config withPath(String path)

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Parameters:

path - The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Parameters:

roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

getRoleArn

public String getRoleArn()

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Returns:

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

withRoleArn

public S3Config withRoleArn(String roleArn)

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Parameters:

roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

Returns:

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

setKMSKeyArn

public void setKMSKeyArn(String kMSKeyArn)

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Parameters:

kMSKeyArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

getKMSKeyArn

public String getKMSKeyArn()

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Returns:

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

withKMSKeyArn

public S3Config withKMSKeyArn(String kMSKeyArn)

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

Parameters:

kMSKeyArn - The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

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