CreateSecretRequest (AWS Java SDK :: Services :: AWS Secrets Manager 2.17.82 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
    - - software.amazon.awssdk.services.secretsmanager.model.CreateSecretRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateSecretRequest.Builder,CreateSecretRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateSecretRequest
extends SecretsManagerRequest
implements ToCopyableBuilder<CreateSecretRequest.Builder,CreateSecretRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateSecretRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateSecretRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ReplicaRegionType>`	`addReplicaRegions()` (Optional) Add a list of regions to replicate secrets.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`forceOverwriteReplicaSecret()` (Optional) If set, the replication overwrites a secret with the same name in the destination region.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddReplicaRegions()` For responses, this returns true if the service returned a value for the AddReplicaRegions property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()` (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services 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.
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    Specifies the friendly name of the new secret.
    
    The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
    
    Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
    
    Returns:
    
    Specifies the friendly name of the new secret.
    
    The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
    
    Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
  - clientRequestToken
```
public final 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 Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it 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 the 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 the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.
    - 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 VersionId of the new version.
    Returns:
    (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 Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it 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 the 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 the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.
    
    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 VersionId of the new version.
  - description
```
public final String description()
```
    (Optional) Specifies a user-provided description of the secret.
    
    Returns:
    
    (Optional) Specifies a user-provided description of the secret.
  - kmsKeyId
```
public final String kmsKeyId()
```
    (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.
    
    You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
    
    If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager). If a Amazon Web Services 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 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 resides in a different account, then you must create a custom CMK and specify the ARN in this field.
    
    Returns:
    
    (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.
    
    You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
    
    If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager). If a Amazon Web Services 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 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 resides in a different account, then you must create a custom CMK and specify the ARN in this field.
  - secretBinary
```
public final 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 Amazon Web Services CLI or one of the Amazon Web Services SDKs.
    
    Returns:
    
    (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 Amazon Web Services CLI or one of the Amazon Web Services SDKs.
  - secretString
```
public final 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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
    
    Returns:
    
    (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 more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
  - hasTags
```
public final boolean hasTags()
```
    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 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.
  - tags
```
public final 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 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 Amazon Web Services reserves it for Amazon Web Services 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 you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: 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.
    
    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 hasTags() method.
    Returns:
    (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 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 Amazon Web Services reserves it for Amazon Web Services 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 you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
  - hasAddReplicaRegions
```
public final boolean hasAddReplicaRegions()
```
    For responses, this returns true if the service returned a value for the AddReplicaRegions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - addReplicaRegions
```
public final List<ReplicaRegionType> addReplicaRegions()
```
    (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
    
    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 hasAddReplicaRegions() method.
    
    Returns:
    
    (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
  - forceOverwriteReplicaSecret
```
public final Boolean forceOverwriteReplicaSecret()
```
    (Optional) If set, the replication overwrites a secret with the same name in the destination region.
    
    Returns:
    
    (Optional) If set, the replication overwrites a secret with the same name in the destination region.
  - toBuilder
```
public CreateSecretRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateSecretRequest.Builder,CreateSecretRequest>
    
    Specified by:
    
    toBuilder in class SecretsManagerRequest
  - builder
```
public static CreateSecretRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateSecretRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateSecretRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

clientRequestToken

description

kmsKeyId

secretBinary

secretString

hasTags

tags

hasAddReplicaRegions

addReplicaRegions

forceOverwriteReplicaSecret

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields