JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.secretsmanager.model

Class PutSecretValueRequest

    • Constructor Detail

      • PutSecretValueRequest

        public PutSecretValueRequest()
    • Method Detail

      • setSecretId

        public void setSecretId(String secretId)

        The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

        Parameters:
        secretId - The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

      • getSecretId

        public String getSecretId()

        The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

        Returns:
        The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

      • withSecretId

        public PutSecretValueRequest withSecretId(String secretId)

        The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

        Parameters:
        secretId - The ARN or name of the secret to add a new version to.

        For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

        If the secret doesn't already exist, use CreateSecret instead.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setClientRequestToken

        public void setClientRequestToken(String clientRequestToken)

        A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

        Parameters:
        clientRequestToken - A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

      • getClientRequestToken

        public String getClientRequestToken()

        A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

        Returns:
        A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

      • withClientRequestToken

        public PutSecretValueRequest withClientRequestToken(String clientRequestToken)

        A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

        Parameters:
        clientRequestToken - A unique identifier for the new version of the secret.

        If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs 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 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it 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 or 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 the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

        This value becomes the VersionId of the new version.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSecretBinary

        public void setSecretBinary(ByteBuffer secretBinary)

        The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

        Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

        Parameters:
        secretBinary - The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • getSecretBinary

        public ByteBuffer getSecretBinary()

        The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

        Returns:
        The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • withSecretBinary

        public PutSecretValueRequest withSecretBinary(ByteBuffer secretBinary)

        The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

        Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

        Parameters:
        secretBinary - The binary data 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 pass the contents of the file as a parameter.

        You must include SecretBinary or SecretString, but not both.

        You can't access this value from the Secrets Manager console.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSecretString

        public void setSecretString(String secretString)

        The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Parameters:
        secretString - The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • getSecretString

        public String getSecretString()

        The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Returns:
        The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • withSecretString

        public PutSecretValueRequest withSecretString(String secretString)

        The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Parameters:
        secretString - The text to encrypt and store in the new version of the secret.

        You must include SecretBinary or SecretString, but not both.

        We recommend you create the secret string as JSON key/value pairs, as shown in the example.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getVersionStages

        public List<String> getVersionStages()

        A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        Returns:
        A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

      • setVersionStages

        public void setVersionStages(Collection<String> versionStages)

        A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        Parameters:
        versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

      • withVersionStages

        public PutSecretValueRequest withVersionStages(String... versionStages)

        A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        NOTE: This method appends the values to the existing list (if any). Use setVersionStages(java.util.Collection) or withVersionStages(java.util.Collection) if you want to override the existing values.

        Parameters:
        versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withVersionStages

        public PutSecretValueRequest withVersionStages(Collection<String> versionStages)

        A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        Parameters:
        versionStages - A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

        If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

        If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRotationToken

        public void setRotationToken(String rotationToken)

        A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Parameters:
        rotationToken - A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • getRotationToken

        public String getRotationToken()

        A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Returns:
        A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

      • withRotationToken

        public PutSecretValueRequest withRotationToken(String rotationToken)

        A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Parameters:
        rotationToken - A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.

        Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /