public static interface GetParametersByPathRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetParametersByPathRequest.Builder path(String path)
The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name.
A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
path - The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter
name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33GetParametersByPathRequest.Builder recursive(Boolean recursive)
Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path. For example, if a user has
permission to access path /a, then the user can also access /a/b. Even if a user
has explicitly been denied access in IAM for parameter /a/b, they can still call the
GetParametersByPath API action recursively for /a and view /a/b.
recursive - Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path. For example, if a
user has permission to access path /a, then the user can also access /a/b.
Even if a user has explicitly been denied access in IAM for parameter /a/b, they can
still call the GetParametersByPath API action recursively for /a and view
/a/b.
GetParametersByPathRequest.Builder parameterFilters(Collection<ParameterStringFilter> parameterFilters)
Filters to limit the request results.
For GetParametersByPath, the following filter Key names are supported:
Type, KeyId, Label, and DataType.
The following Key values are not supported for GetParametersByPath:
tag, Name, Path, and Tier.
parameterFilters - Filters to limit the request results.
For GetParametersByPath, the following filter Key names are supported:
Type, KeyId, Label, and DataType.
The following Key values are not supported for GetParametersByPath:
tag, Name, Path, and Tier.
GetParametersByPathRequest.Builder parameterFilters(ParameterStringFilter... parameterFilters)
Filters to limit the request results.
For GetParametersByPath, the following filter Key names are supported:
Type, KeyId, Label, and DataType.
The following Key values are not supported for GetParametersByPath:
tag, Name, Path, and Tier.
parameterFilters - Filters to limit the request results.
For GetParametersByPath, the following filter Key names are supported:
Type, KeyId, Label, and DataType.
The following Key values are not supported for GetParametersByPath:
tag, Name, Path, and Tier.
GetParametersByPathRequest.Builder parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters)
Filters to limit the request results.
For GetParametersByPath, the following filter Key names are supported:
Type, KeyId, Label, and DataType.
The following Key values are not supported for GetParametersByPath:
tag, Name, Path, and Tier.
List.Builder
avoiding the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called
immediately and its result is passed to #parameterFilters(List) .parameterFilters - a consumer that will call methods on List.Builder #parameterFilters(List) GetParametersByPathRequest.Builder withDecryption(Boolean withDecryption)
Retrieve all parameters in a hierarchy with their value decrypted.
withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.GetParametersByPathRequest.Builder maxResults(Integer maxResults)
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
maxResults - The maximum number of items to return for this call. The call also returns a token that you can
specify in a subsequent call to get the next set of results.GetParametersByPathRequest.Builder nextToken(String nextToken)
A token to start the list. Use this token to get the next set of results.
nextToken - A token to start the list. Use this token to get the next set of results.GetParametersByPathRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGetParametersByPathRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.