class Amazonite::Ssm::GetParametersByPathRequest

Included Modules

Defined in:

ssm/get_parameters_by_path_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(path : String, recursive : Bool | Nil = nil, parameter_filters : Array(ParameterStringFilter) | Nil = nil, with_decryption : Bool | Nil = nil, max_results : Int32 | Nil = nil, next_token : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def max_results : Int32 | Nil #

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.


[View source]
def max_results=(max_results : Int32 | Nil) #

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.


[View source]
def next_token : String | Nil #

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


[View source]
def next_token=(next_token : String | Nil) #

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


[View source]
def parameter_filters : Array(ParameterStringFilter) | Nil #

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.


[View source]
def parameter_filters=(parameter_filters : Array(ParameterStringFilter) | Nil) #

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.


[View source]
def path : 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


[View source]
def path=(path : 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


[View source]
def recursive : Bool | Nil #

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.


[View source]
def recursive=(recursive : Bool | Nil) #

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.


[View source]
def validate! : Nil #

[View source]
def with_decryption : Bool | Nil #

Retrieve all parameters in a hierarchy with their value decrypted.


[View source]
def with_decryption=(with_decryption : Bool | Nil) #

Retrieve all parameters in a hierarchy with their value decrypted.


[View source]