class Amazonite::Ssm::DocumentParameter

Overview

Parameters specified in a Systems Manager document that run on the server when the command is run.

Included Modules

Defined in:

ssm/document_parameter.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(name : String | Nil = nil, type : DocumentParameterType | Nil = nil, description : String | Nil = nil, default_value : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[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 default_value : String | Nil #

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.


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

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.


[View source]
def description : String | Nil #

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.


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

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String | Nil #

The name of the parameter.


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

The name of the parameter.


[View source]
def type : DocumentParameterType | Nil #

The type of parameter. The type can be either String or StringList.


[View source]
def type=(type : DocumentParameterType | Nil) #

The type of parameter. The type can be either String or StringList.


[View source]
def validate! : Nil #

[View source]