Package software.amazon.awssdk.services.ssm.model

Interface GetParametersByPathRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>, SdkBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
GetParametersByPathRequest
public static interface GetParametersByPathRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

  • Method Details

    • path

      GetParametersByPathRequest.Builder path(String path)

      The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

      Parameters:
      path - The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recursive

      GetParametersByPathRequest.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 operation recursively for /a and view /a/b.

      Parameters:
      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 operation recursively for /a and view /a/b.

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

    • parameterFilters

      GetParametersByPathRequest.Builder parameterFilters(Collection<ParameterStringFilter> parameterFilters)

      Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

      Parameters:
      parameterFilters - Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

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

    • parameterFilters

      GetParametersByPathRequest.Builder parameterFilters(ParameterStringFilter... parameterFilters)

      Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

      Parameters:
      parameterFilters - Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

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

    • parameterFilters

      GetParametersByPathRequest.Builder parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters)

      Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

      This is a convenience method that creates an instance of the ParameterStringFilter.Builder avoiding the need to create one manually via ParameterStringFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterFilters(List<ParameterStringFilter>).

      Parameters:
      parameterFilters - a consumer that will call methods on ParameterStringFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • withDecryption

      GetParametersByPathRequest.Builder withDecryption(Boolean withDecryption)

      Retrieve all parameters in a hierarchy with their value decrypted.

      Parameters:
      withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetParametersByPathRequest.Builder nextToken(String nextToken)

      A token to start the list. Use this token to get the next set of results.

      Parameters:
      nextToken - A token to start the list. Use this token to get the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetParametersByPathRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetParametersByPathRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.