@Generated(value="software.amazon.awssdk:codegen") public final class CreateSecretRequest extends SecretsManagerRequest implements ToCopyableBuilder<CreateSecretRequest.Builder,CreateSecretRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateSecretRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateSecretRequest.Builder |
builder() |
String |
clientRequestToken()
(Optional) If you include
SecretString or SecretBinary , then an initial version is
created as part of the secret, and this parameter specifies a unique identifier for the new version. |
String |
description()
(Optional) Specifies a user-provided description of the secret.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
kmsKeyId()
(Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the
SecretString or SecretBinary values in the versions stored in this secret. |
String |
name()
Specifies the friendly name of the new secret.
|
SdkBytes |
secretBinary()
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret.
|
String |
secretString()
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
|
static Class<? extends CreateSecretRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
(Optional) Specifies a list of user-defined tags that are attached to the secret.
|
CreateSecretRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String name()
Specifies the friendly name of the new secret.
public String clientRequestToken()
(Optional) If you include SecretString
or SecretBinary
, then an initial version is
created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The
CLI or SDK generates a random UUID for you and includes as the value for this parameter in the request. If you
don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must
generate a ClientRequestToken
yourself for the new version and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new
version of the secret is created.
If a version with this value already exists and that version's SecretString
and
SecretBinary
values are the same as those in the request, then the request is ignored (the operation
is idempotent).
If a version with this value already exists and that version's SecretString
and
SecretBinary
values are different from those in the request then the request fails because you
cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the SecretVersionId
of the new version.
SecretString
or SecretBinary
, then an initial version
is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter
empty. The CLI or SDK generates a random UUID for you and includes as the value for this parameter in the
request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service
endpoint, then you must generate a ClientRequestToken
yourself for the new version and
include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a
new version of the secret is created.
If a version with this value already exists and that version's SecretString
and
SecretBinary
values are the same as those in the request, then the request is ignored (the
operation is idempotent).
If a version with this value already exists and that version's SecretString
and
SecretBinary
values are different from those in the request then the request fails because
you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the SecretVersionId
of the new version.
public String description()
(Optional) Specifies a user-provided description of the secret.
public String kmsKeyId()
(Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the
SecretString
or SecretBinary
values in the versions stored in this secret.
If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one
named aws/secretsmanager
). If a KMS CMK with that name doesn't yet exist, then Secrets Manager
creates it for you automatically the first time it needs to encrypt a version's SecretString
or
SecretBinary
fields.
You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret.
If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK
(the one named aws/secretsmanager
). If a KMS CMK with that name doesn't yet exist, then
Secrets Manager creates it for you automatically the first time it needs to encrypt a version's
SecretString
or SecretBinary
fields.
You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.
public SdkBytes secretBinary()
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.
Either SecretString
or SecretBinary
must have a value, but not both. They
cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.
public String secretString()
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text
in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
Either SecretString
or SecretBinary
must have a value, but not both. They
cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
secret text in only the SecretString
parameter. The Secrets Manager console stores the
information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
public List<Tag> tags()
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
removing a tag can change permissions. If the successful completion of this operation would result in you losing
your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because it is reserved for AWS use. You can't
edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per
secret limit.
If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in IAM policy Condition
elements as part of your security strategy, then
adding or removing a tag can change permissions. If the successful completion of this operation would
result in you losing your permissions for this secret, then this operation is blocked and returns an
Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because it is reserved for AWS use.
You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against
your tags per secret limit.
If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
public CreateSecretRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateSecretRequest.Builder,CreateSecretRequest>
toBuilder
in class SecretsManagerRequest
public static CreateSecretRequest.Builder builder()
public static Class<? extends CreateSecretRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.