@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateFileSystemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateFileSystemRequest() |
Modifier and Type | Method and Description |
---|---|
CreateFileSystemRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCreationToken()
A string of up to 64 ASCII characters.
|
Boolean |
getEncrypted()
A Boolean value that, if true, creates an encrypted file system.
|
String |
getKmsKeyId()
The ID of the AWS KMS CMK to be used to protect the encrypted file system.
|
String |
getPerformanceMode()
The performance mode of the file system.
|
Double |
getProvisionedThroughputInMibps()
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
|
List<Tag> |
getTags()
A value that specifies to create one or more tags associated with the file system.
|
String |
getThroughputMode()
The throughput mode for the file system to be created.
|
int |
hashCode() |
Boolean |
isEncrypted()
A Boolean value that, if true, creates an encrypted file system.
|
void |
setCreationToken(String creationToken)
A string of up to 64 ASCII characters.
|
void |
setEncrypted(Boolean encrypted)
A Boolean value that, if true, creates an encrypted file system.
|
void |
setKmsKeyId(String kmsKeyId)
The ID of the AWS KMS CMK to be used to protect the encrypted file system.
|
void |
setPerformanceMode(PerformanceMode performanceMode)
The performance mode of the file system.
|
void |
setPerformanceMode(String performanceMode)
The performance mode of the file system.
|
void |
setProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
|
void |
setTags(Collection<Tag> tags)
A value that specifies to create one or more tags associated with the file system.
|
void |
setThroughputMode(String throughputMode)
The throughput mode for the file system to be created.
|
void |
setThroughputMode(ThroughputMode throughputMode)
The throughput mode for the file system to be created.
|
String |
toString()
Returns a string representation of this object.
|
CreateFileSystemRequest |
withCreationToken(String creationToken)
A string of up to 64 ASCII characters.
|
CreateFileSystemRequest |
withEncrypted(Boolean encrypted)
A Boolean value that, if true, creates an encrypted file system.
|
CreateFileSystemRequest |
withKmsKeyId(String kmsKeyId)
The ID of the AWS KMS CMK to be used to protect the encrypted file system.
|
CreateFileSystemRequest |
withPerformanceMode(PerformanceMode performanceMode)
The performance mode of the file system.
|
CreateFileSystemRequest |
withPerformanceMode(String performanceMode)
The performance mode of the file system.
|
CreateFileSystemRequest |
withProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
|
CreateFileSystemRequest |
withTags(Collection<Tag> tags)
A value that specifies to create one or more tags associated with the file system.
|
CreateFileSystemRequest |
withTags(Tag... tags)
A value that specifies to create one or more tags associated with the file system.
|
CreateFileSystemRequest |
withThroughputMode(String throughputMode)
The throughput mode for the file system to be created.
|
CreateFileSystemRequest |
withThroughputMode(ThroughputMode throughputMode)
The throughput mode for the file system to be created.
|
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
public void setCreationToken(String creationToken)
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
creationToken
- A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.public String getCreationToken()
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
public CreateFileSystemRequest withCreationToken(String creationToken)
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
creationToken
- A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.public void setPerformanceMode(String performanceMode)
The performance mode of the file system. We recommend generalPurpose
performance mode for most file
systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate
throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
performance mode can't be changed after the file system has been created.
performanceMode
- The performance mode of the file system. We recommend generalPurpose
performance mode for
most file systems. File systems using the maxIO
performance mode can scale to higher levels
of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most
file operations. The performance mode can't be changed after the file system has been created.PerformanceMode
public String getPerformanceMode()
The performance mode of the file system. We recommend generalPurpose
performance mode for most file
systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate
throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
performance mode can't be changed after the file system has been created.
generalPurpose
performance mode for
most file systems. File systems using the maxIO
performance mode can scale to higher levels
of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most
file operations. The performance mode can't be changed after the file system has been created.PerformanceMode
public CreateFileSystemRequest withPerformanceMode(String performanceMode)
The performance mode of the file system. We recommend generalPurpose
performance mode for most file
systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate
throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
performance mode can't be changed after the file system has been created.
performanceMode
- The performance mode of the file system. We recommend generalPurpose
performance mode for
most file systems. File systems using the maxIO
performance mode can scale to higher levels
of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most
file operations. The performance mode can't be changed after the file system has been created.PerformanceMode
public void setPerformanceMode(PerformanceMode performanceMode)
The performance mode of the file system. We recommend generalPurpose
performance mode for most file
systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate
throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
performance mode can't be changed after the file system has been created.
performanceMode
- The performance mode of the file system. We recommend generalPurpose
performance mode for
most file systems. File systems using the maxIO
performance mode can scale to higher levels
of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most
file operations. The performance mode can't be changed after the file system has been created.PerformanceMode
public CreateFileSystemRequest withPerformanceMode(PerformanceMode performanceMode)
The performance mode of the file system. We recommend generalPurpose
performance mode for most file
systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate
throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
performance mode can't be changed after the file system has been created.
performanceMode
- The performance mode of the file system. We recommend generalPurpose
performance mode for
most file systems. File systems using the maxIO
performance mode can scale to higher levels
of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most
file operations. The performance mode can't be changed after the file system has been created.PerformanceMode
public void setEncrypted(Boolean encrypted)
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.
encrypted
- A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system,
you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key
Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK
for Amazon EFS, /aws/elasticfilesystem
, is used to protect the encrypted file system.public Boolean getEncrypted()
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.
/aws/elasticfilesystem
, is used to protect the encrypted file system.public CreateFileSystemRequest withEncrypted(Boolean encrypted)
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.
encrypted
- A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system,
you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key
Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK
for Amazon EFS, /aws/elasticfilesystem
, is used to protect the encrypted file system.public Boolean isEncrypted()
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
/aws/elasticfilesystem
, is used to protect the encrypted file system.
/aws/elasticfilesystem
, is used to protect the encrypted file system.public void setKmsKeyId(String kmsKeyId)
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set to
true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
kmsKeyId
- The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required
if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is
used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set
to true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
public String getKmsKeyId()
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set to
true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set
to true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
public CreateFileSystemRequest withKmsKeyId(String kmsKeyId)
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set to
true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
kmsKeyId
- The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required
if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is
used. This ID can be in one of the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example alias/projectKey1
.
Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
If KmsKeyId
is specified, the CreateFileSystemRequest$Encrypted parameter must be set
to true.
EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
public void setThroughputMode(String throughputMode)
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting
and provisioned
. If you set ThroughputMode
to
provisioned
, you must also set a value for ProvisionedThroughPutInMibps
. You can
decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
throughputMode
- The throughput mode for the file system to be created. There are two throughput modes to choose from for
your file system: bursting
and provisioned
. If you set
ThroughputMode
to provisioned
, you must also set a value for
ProvisionedThroughPutInMibps
. You can decrease your file system's throughput in Provisioned
Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the
last decrease or throughput mode change. For more, see Specifying
Throughput with Provisioned Mode in the Amazon EFS User Guide.ThroughputMode
public String getThroughputMode()
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting
and provisioned
. If you set ThroughputMode
to
provisioned
, you must also set a value for ProvisionedThroughPutInMibps
. You can
decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
bursting
and provisioned
. If you set
ThroughputMode
to provisioned
, you must also set a value for
ProvisionedThroughPutInMibps
. You can decrease your file system's throughput in Provisioned
Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the
last decrease or throughput mode change. For more, see Specifying
Throughput with Provisioned Mode in the Amazon EFS User Guide.ThroughputMode
public CreateFileSystemRequest withThroughputMode(String throughputMode)
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting
and provisioned
. If you set ThroughputMode
to
provisioned
, you must also set a value for ProvisionedThroughPutInMibps
. You can
decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
throughputMode
- The throughput mode for the file system to be created. There are two throughput modes to choose from for
your file system: bursting
and provisioned
. If you set
ThroughputMode
to provisioned
, you must also set a value for
ProvisionedThroughPutInMibps
. You can decrease your file system's throughput in Provisioned
Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the
last decrease or throughput mode change. For more, see Specifying
Throughput with Provisioned Mode in the Amazon EFS User Guide.ThroughputMode
public void setThroughputMode(ThroughputMode throughputMode)
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting
and provisioned
. If you set ThroughputMode
to
provisioned
, you must also set a value for ProvisionedThroughPutInMibps
. You can
decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
throughputMode
- The throughput mode for the file system to be created. There are two throughput modes to choose from for
your file system: bursting
and provisioned
. If you set
ThroughputMode
to provisioned
, you must also set a value for
ProvisionedThroughPutInMibps
. You can decrease your file system's throughput in Provisioned
Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the
last decrease or throughput mode change. For more, see Specifying
Throughput with Provisioned Mode in the Amazon EFS User Guide.ThroughputMode
public CreateFileSystemRequest withThroughputMode(ThroughputMode throughputMode)
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting
and provisioned
. If you set ThroughputMode
to
provisioned
, you must also set a value for ProvisionedThroughPutInMibps
. You can
decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
throughputMode
- The throughput mode for the file system to be created. There are two throughput modes to choose from for
your file system: bursting
and provisioned
. If you set
ThroughputMode
to provisioned
, you must also set a value for
ProvisionedThroughPutInMibps
. You can decrease your file system's throughput in Provisioned
Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the
last decrease or throughput mode change. For more, see Specifying
Throughput with Provisioned Mode in the Amazon EFS User Guide.ThroughputMode
public void setProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid
values are 1-1024. Required if ThroughputMode
is set to provisioned
. The upper limit
for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information,
see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
provisionedThroughputInMibps
- The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
Valid values are 1-1024. Required if ThroughputMode
is set to provisioned
. The
upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For
more information, see Amazon
EFS Limits That You Can Increase in the Amazon EFS User Guide.public Double getProvisionedThroughputInMibps()
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid
values are 1-1024. Required if ThroughputMode
is set to provisioned
. The upper limit
for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information,
see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
ThroughputMode
is set to provisioned
. The
upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For
more information, see Amazon
EFS Limits That You Can Increase in the Amazon EFS User Guide.public CreateFileSystemRequest withProvisionedThroughputInMibps(Double provisionedThroughputInMibps)
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid
values are 1-1024. Required if ThroughputMode
is set to provisioned
. The upper limit
for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information,
see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
provisionedThroughputInMibps
- The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
Valid values are 1-1024. Required if ThroughputMode
is set to provisioned
. The
upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For
more information, see Amazon
EFS Limits That You Can Increase in the Amazon EFS User Guide.public List<Tag> getTags()
A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined
key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
key-value pair.
"Key":"Name","Value":"{value}"
key-value pair.public void setTags(Collection<Tag> tags)
A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined
key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
key-value pair.
tags
- A value that specifies to create one or more tags associated with the file system. Each tag is a
user-defined key-value pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair.public CreateFileSystemRequest withTags(Tag... tags)
A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined
key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
key-value pair.
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.
tags
- A value that specifies to create one or more tags associated with the file system. Each tag is a
user-defined key-value pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair.public CreateFileSystemRequest withTags(Collection<Tag> tags)
A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined
key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
key-value pair.
tags
- A value that specifies to create one or more tags associated with the file system. Each tag is a
user-defined key-value pair. Name your file system on creation by including a
"Key":"Name","Value":"{value}"
key-value pair.public String toString()
toString
in class Object
Object.toString()
public CreateFileSystemRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.