public static interface ListSecretVersionIdsRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<ListSecretVersionIdsRequest.Builder,ListSecretVersionIdsRequest>
| Modifier and Type | Method and Description |
|---|---|
ListSecretVersionIdsRequest.Builder |
includeDeprecated(Boolean includeDeprecated)
(Optional) Specifies that you want the results to include versions that do not have any staging labels
attached to them.
|
ListSecretVersionIdsRequest.Builder |
maxResults(Integer maxResults)
(Optional) Limits the number of results that you want to include in the response.
|
ListSecretVersionIdsRequest.Builder |
nextToken(String nextToken)
(Optional) Use this parameter in a request if you receive a
NextToken response in a previous
request that indicates that there's more output available. |
ListSecretVersionIdsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
ListSecretVersionIdsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
ListSecretVersionIdsRequest.Builder |
secretId(String secretId)
The identifier for the secret containing the versions you want to list.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildListSecretVersionIdsRequest.Builder secretId(String secretId)
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
secretId - The identifier for the secret containing the versions you want to list. You can specify either the
Amazon Resource Name (ARN) or the friendly name of the secret. If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.
ListSecretVersionIdsRequest.Builder maxResults(Integer maxResults)
(Optional) Limits the number of results that you want to include in the response. If you don't include this
parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the
maximum you specify, the NextToken response element is present and has a value (isn't null).
Include that value as the NextToken request parameter in the next call to the operation to get
the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when
there are more results available. You should check NextToken after every operation to ensure
that you receive all of the results.
maxResults - (Optional) Limits the number of results that you want to include in the response. If you don't include
this parameter, it defaults to a value that's specific to the operation. If additional items exist
beyond the maximum you specify, the NextToken response element is present and has a value
(isn't null). Include that value as the NextToken request parameter in the next call to
the operation to get the next part of the results. Note that Secrets Manager might return fewer
results than the maximum even when there are more results available. You should check
NextToken after every operation to ensure that you receive all of the results.ListSecretVersionIdsRequest.Builder nextToken(String nextToken)
(Optional) Use this parameter in a request if you receive a NextToken response in a previous
request that indicates that there's more output available. In a subsequent call, set it to the value of the
previous call's NextToken response to indicate where the output should continue from.
nextToken - (Optional) Use this parameter in a request if you receive a NextToken response in a
previous request that indicates that there's more output available. In a subsequent call, set it to
the value of the previous call's NextToken response to indicate where the output should
continue from.ListSecretVersionIdsRequest.Builder includeDeprecated(Boolean includeDeprecated)
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
includeDeprecated - (Optional) Specifies that you want the results to include versions that do not have any staging labels
attached to them. Such versions are considered deprecated and are subject to deletion by Secrets
Manager as needed.ListSecretVersionIdsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderListSecretVersionIdsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.