Struct DocumentParameter

#[non_exhaustive]
pub struct DocumentParameter {
    pub name: Option<String>,
    pub type: Option<DocumentParameterType>,
    pub description: Option<String>,
    pub default_value: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the parameter.

type: Option<DocumentParameterType>

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

description: Option<String>

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

default_value: Option<String>

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

Implementations

impl DocumentParameter

pub fn name(&self) -> Option<&str>

The name of the parameter.

pub fn type(&self) -> Option<&DocumentParameterType>

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

pub fn description(&self) -> Option<&str>

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

pub fn default_value(&self) -> Option<&str>

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

impl DocumentParameter

pub fn builder() -> DocumentParameterBuilder

Creates a new builder-style object to manufacture DocumentParameter.

Trait Implementations

impl Clone for DocumentParameter

fn clone(&self) -> DocumentParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentParameter

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

Formats the value using the given formatter.

impl PartialEq for DocumentParameter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DocumentParameter