com.amazonaws.services.forecast.model

Class EncryptionConfig

java.lang.Object

com.amazonaws.services.forecast.model.EncryptionConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EncryptionConfig()

Method Summary

Modifier and Type	Method and Description
EncryptionConfig	clone()
boolean	equals(Object obj)
String	getKMSKeyArn() The Amazon Resource Name (ARN) of the KMS key.
String	getRoleArn() The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKMSKeyArn(String kMSKeyArn) The Amazon Resource Name (ARN) of the KMS key.
void	setRoleArn(String roleArn) The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
String	toString() Returns a string representation of this object.
EncryptionConfig	withKMSKeyArn(String kMSKeyArn) The Amazon Resource Name (ARN) of the KMS key.
EncryptionConfig	withRoleArn(String roleArn) The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EncryptionConfig

public EncryptionConfig()

Method Detail

setRoleArn

public void setRoleArn(String roleArn)

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS 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 IAM role that Amazon Forecast can assume to access the AWS KMS 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 IAM role that Amazon Forecast can assume to access the AWS KMS 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 IAM role that Amazon Forecast can assume to access the AWS KMS 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 EncryptionConfig withRoleArn(String roleArn)

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS 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 IAM role that Amazon Forecast can assume to access the AWS KMS 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 the KMS key.

Parameters:

kMSKeyArn - The Amazon Resource Name (ARN) of the KMS key.

getKMSKeyArn

public String getKMSKeyArn()

The Amazon Resource Name (ARN) of the KMS key.

Returns:

The Amazon Resource Name (ARN) of the KMS key.

withKMSKeyArn

public EncryptionConfig withKMSKeyArn(String kMSKeyArn)

The Amazon Resource Name (ARN) of the KMS key.

Parameters:

kMSKeyArn - The Amazon Resource Name (ARN) of the 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 EncryptionConfig 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.