software.amazon.awssdk.services.qldb.model.CreateLedgerRequest Maven / Gradle / Ivy
Show all versions of qldb Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.qldb.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateLedgerRequest extends QldbRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateLedgerRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateLedgerRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField PERMISSIONS_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PermissionsMode").getter(getter(CreateLedgerRequest::permissionsModeAsString))
.setter(setter(Builder::permissionsMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsMode").build()).build();
private static final SdkField DELETION_PROTECTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DeletionProtection").getter(getter(CreateLedgerRequest::deletionProtection))
.setter(setter(Builder::deletionProtection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeletionProtection").build())
.build();
private static final SdkField KMS_KEY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KmsKey")
.getter(getter(CreateLedgerRequest::kmsKey)).setter(setter(Builder::kmsKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKey").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, TAGS_FIELD,
PERMISSIONS_MODE_FIELD, DELETION_PROTECTION_FIELD, KMS_KEY_FIELD));
private final String name;
private final Map tags;
private final String permissionsMode;
private final Boolean deletionProtection;
private final String kmsKey;
private CreateLedgerRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.tags = builder.tags;
this.permissionsMode = builder.permissionsMode;
this.deletionProtection = builder.deletionProtection;
this.kmsKey = builder.kmsKey;
}
/**
*
* The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon
* Web Services account in the current Region.
*
*
* Naming constraints for ledger names are defined in Quotas in Amazon QLDB
* in the Amazon QLDB Developer Guide.
*
*
* @return The name of the ledger that you want to create. The name must be unique among all of the ledgers in your
* Amazon Web Services account in the current Region.
*
* Naming constraints for ledger names are defined in Quotas in Amazon
* QLDB in the Amazon QLDB Developer Guide.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values
* are case sensitive and can be null.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive.
* Tag values are case sensitive and can be null.
*/
public final Map tags() {
return tags;
}
/**
*
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
* ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL
* commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any
* table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer granularity
* for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow
* PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL
* actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started
* with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger
* data.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #permissionsMode}
* will return {@link PermissionsMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #permissionsModeAsString}.
*
*
* @return The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity
* for ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode
* disregards any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger.
* To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources
* and PartiQL actions, in addition to the SendCommand API permission for the ledger. For
* information, see Getting
* started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your
* ledger data.
*
* @see PermissionsMode
*/
public final PermissionsMode permissionsMode() {
return PermissionsMode.fromValue(permissionsMode);
}
/**
*
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
* ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL
* commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards any
* table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer granularity
* for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow
* PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL
* actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started
* with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger
* data.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #permissionsMode}
* will return {@link PermissionsMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #permissionsModeAsString}.
*
*
* @return The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity
* for ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode
* disregards any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger.
* To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources
* and PartiQL actions, in addition to the SendCommand API permission for the ledger. For
* information, see Getting
* started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your
* ledger data.
*
* @see PermissionsMode
*/
public final String permissionsModeAsString() {
return permissionsMode;
}
/**
*
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation,
* this feature is enabled (true) by default.
*
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it
* by calling the UpdateLedger operation to set this parameter to false.
*
*
* @return Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to false.
*/
public final Boolean deletionProtection() {
return deletionProtection;
}
/**
*
* The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more
* information, see Encryption at rest in
* the Amazon QLDB Developer Guide.
*
*
* Use one of the following options to specify this parameter:
*
*
* -
*
* AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.
*
*
* -
*
* Undefined: By default, use an Amazon Web Services owned KMS key.
*
*
* -
*
* A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in your account
* that you create, own, and manage.
*
*
* Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and
* asymmetric keys in the Key Management Service Developer Guide.
*
*
*
*
* To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias
* ARN. When using an alias name, prefix it with "alias/". To specify a key in a different Amazon Web
* Services account, you must use the key ARN or alias ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* For more information, see Key identifiers (KeyId) in
* the Key Management Service Developer Guide.
*
*
* @return The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more
* information, see Encryption at
* rest in the Amazon QLDB Developer Guide.
*
* Use one of the following options to specify this parameter:
*
*
* -
*
* AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your
* behalf.
*
*
* -
*
* Undefined: By default, use an Amazon Web Services owned KMS key.
*
*
* -
*
* A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in your
* account that you create, own, and manage.
*
*
* Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric
* and asymmetric keys in the Key Management Service Developer Guide.
*
*
*
*
* To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or
* alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a
* different Amazon Web Services account, you must use the key ARN or alias ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* For more information, see Key identifiers
* (KeyId) in the Key Management Service Developer Guide.
*/
public final String kmsKey() {
return kmsKey;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(permissionsModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(deletionProtection());
hashCode = 31 * hashCode + Objects.hashCode(kmsKey());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateLedgerRequest)) {
return false;
}
CreateLedgerRequest other = (CreateLedgerRequest) obj;
return Objects.equals(name(), other.name()) && hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(permissionsModeAsString(), other.permissionsModeAsString())
&& Objects.equals(deletionProtection(), other.deletionProtection()) && Objects.equals(kmsKey(), other.kmsKey());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateLedgerRequest").add("Name", name()).add("Tags", hasTags() ? tags() : null)
.add("PermissionsMode", permissionsModeAsString()).add("DeletionProtection", deletionProtection())
.add("KmsKey", kmsKey()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "PermissionsMode":
return Optional.ofNullable(clazz.cast(permissionsModeAsString()));
case "DeletionProtection":
return Optional.ofNullable(clazz.cast(deletionProtection()));
case "KmsKey":
return Optional.ofNullable(clazz.cast(kmsKey()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateLedgerRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QldbRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the ledger that you want to create. The name must be unique among all of the ledgers in your
* Amazon Web Services account in the current Region.
*
*
* Naming constraints for ledger names are defined in Quotas in Amazon
* QLDB in the Amazon QLDB Developer Guide.
*
*
* @param name
* The name of the ledger that you want to create. The name must be unique among all of the ledgers in
* your Amazon Web Services account in the current Region.
*
* Naming constraints for ledger names are defined in Quotas in
* Amazon QLDB in the Amazon QLDB Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag
* values are case sensitive and can be null.
*
*
* @param tags
* The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive.
* Tag values are case sensitive and can be null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
* ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards
* any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To
* allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and
* PartiQL actions, in addition to the SendCommand API permission for the ledger. For information,
* see Getting
* started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your
* ledger data.
*
*
*
* @param permissionsMode
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of
* the following values:
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level
* granularity for ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode
* disregards any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this
* ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table
* resources and PartiQL actions, in addition to the SendCommand API permission for the
* ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of
* your ledger data.
*
* @see PermissionsMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionsMode
*/
Builder permissionsMode(String permissionsMode);
/**
*
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of the
* following values:
*
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level granularity for
* ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode disregards
* any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To
* allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and
* PartiQL actions, in addition to the SendCommand API permission for the ledger. For information,
* see Getting
* started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of your
* ledger data.
*
*
*
* @param permissionsMode
* The permissions mode to assign to the ledger that you want to create. This parameter can have one of
* the following values:
*
* -
*
* ALLOW_ALL: A legacy permissions mode that enables access control with API-level
* granularity for ledgers.
*
*
* This mode allows users who have the SendCommand API permission for this ledger to run all
* PartiQL commands (hence, ALLOW_ALL) on any tables in the specified ledger. This mode
* disregards any table-level or command-level IAM permissions policies that you create for the ledger.
*
*
* -
*
* STANDARD: (Recommended) A permissions mode that enables access control with finer
* granularity for ledgers, tables, and PartiQL commands.
*
*
* By default, this mode denies all user requests to run any PartiQL commands on any tables in this
* ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table
* resources and PartiQL actions, in addition to the SendCommand API permission for the
* ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide.
*
*
*
*
*
* We strongly recommend using the STANDARD permissions mode to maximize the security of
* your ledger data.
*
* @see PermissionsMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionsMode
*/
Builder permissionsMode(PermissionsMode permissionsMode);
/**
*
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to false.
*
*
* @param deletionProtection
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to
* false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deletionProtection(Boolean deletionProtection);
/**
*
* The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more
* information, see Encryption at rest
* in the Amazon QLDB Developer Guide.
*
*
* Use one of the following options to specify this parameter:
*
*
* -
*
* AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on your
* behalf.
*
*
* -
*
* Undefined: By default, use an Amazon Web Services owned KMS key.
*
*
* -
*
* A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in your
* account that you create, own, and manage.
*
*
* Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and
* asymmetric keys in the Key Management Service Developer Guide.
*
*
*
*
* To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or
* alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a different
* Amazon Web Services account, you must use the key ARN or alias ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* For more information, see Key identifiers (KeyId)
* in the Key Management Service Developer Guide.
*
*
* @param kmsKey
* The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more
* information, see Encryption at
* rest in the Amazon QLDB Developer Guide.
*
* Use one of the following options to specify this parameter:
*
*
* -
*
* AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services on
* your behalf.
*
*
* -
*
* Undefined: By default, use an Amazon Web Services owned KMS key.
*
*
* -
*
* A valid symmetric customer managed KMS key: Use the specified symmetric encryption KMS key in
* your account that you create, own, and manage.
*
*
* Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric
* and asymmetric keys in the Key Management Service Developer Guide.
*
*
*
*
* To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name,
* or alias ARN. When using an alias name, prefix it with "alias/". To specify a key in a
* different Amazon Web Services account, you must use the key ARN or alias ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Alias name: alias/ExampleAlias
*
*
* -
*
* Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
*
*
*
*
* For more information, see Key identifiers
* (KeyId) in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKey(String kmsKey);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QldbRequest.BuilderImpl implements Builder {
private String name;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String permissionsMode;
private Boolean deletionProtection;
private String kmsKey;
private BuilderImpl() {
}
private BuilderImpl(CreateLedgerRequest model) {
super(model);
name(model.name);
tags(model.tags);
permissionsMode(model.permissionsMode);
deletionProtection(model.deletionProtection);
kmsKey(model.kmsKey);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
public final String getPermissionsMode() {
return permissionsMode;
}
public final void setPermissionsMode(String permissionsMode) {
this.permissionsMode = permissionsMode;
}
@Override
public final Builder permissionsMode(String permissionsMode) {
this.permissionsMode = permissionsMode;
return this;
}
@Override
public final Builder permissionsMode(PermissionsMode permissionsMode) {
this.permissionsMode(permissionsMode == null ? null : permissionsMode.toString());
return this;
}
public final Boolean getDeletionProtection() {
return deletionProtection;
}
public final void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
@Override
public final Builder deletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
return this;
}
public final String getKmsKey() {
return kmsKey;
}
public final void setKmsKey(String kmsKey) {
this.kmsKey = kmsKey;
}
@Override
public final Builder kmsKey(String kmsKey) {
this.kmsKey = kmsKey;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateLedgerRequest build() {
return new CreateLedgerRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}