Struct aws_sdk_ssm::operation::get_parameters_by_path::builders::GetParametersByPathInputBuilder

#[non_exhaustive]
pub struct GetParametersByPathInputBuilder { /* private fields */ }

A builder for GetParametersByPathInput.

Implementations

impl GetParametersByPathInputBuilder

pub fn path(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_path(self, input: Option<String>) -> Self

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

pub fn get_path(&self) -> &Option<String>

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

pub fn recursive(self, input: bool) -> Self

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.

pub fn set_recursive(self, input: Option<bool>) -> Self

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.

pub fn get_recursive(&self) -> &Option<bool>

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.

pub fn parameter_filters(self, input: ParameterStringFilter) -> Self

Appends an item to parameter_filters.

To override the contents of this collection use set_parameter_filters.

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.

pub fn set_parameter_filters( self, input: Option<Vec<ParameterStringFilter>> ) -> Self

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.

pub fn get_parameter_filters(&self) -> &Option<Vec<ParameterStringFilter>>

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.

pub fn with_decryption(self, input: bool) -> Self

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn set_with_decryption(self, input: Option<bool>) -> Self

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn get_with_decryption(&self) -> &Option<bool>

Retrieve all parameters in a hierarchy with their value decrypted.

pub fn max_results(self, input: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn get_max_results(&self) -> &Option<i32>

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn get_next_token(&self) -> &Option<String>

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

pub fn build(self) -> Result<GetParametersByPathInput, BuildError>

Consumes the builder and constructs a GetParametersByPathInput.

impl GetParametersByPathInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetParametersByPathOutput, SdkError<GetParametersByPathError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetParametersByPathInputBuilder

fn clone(&self) -> GetParametersByPathInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetParametersByPathInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetParametersByPathInputBuilder

fn default() -> GetParametersByPathInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetParametersByPathInputBuilder

fn eq(&self, other: &GetParametersByPathInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetParametersByPathInputBuilder