Struct aws_sdk_iot::types::DocumentParameter

#[non_exhaustive]
pub struct DocumentParameter {
    pub key: Option<String>,
    pub description: Option<String>,
    pub regex: Option<String>,
    pub example: Option<String>,
    pub optional: bool,
}

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

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.

key: Option<String>

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

description: Option<String>

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

regex: Option<String>

A regular expression of the patterns that need to be replaced in a managed template job document schema.

example: Option<String>

An example illustrating a pattern that need to be replaced in a managed template job document schema.

optional: bool

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

Implementations

impl DocumentParameter

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

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

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

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

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

A regular expression of the patterns that need to be replaced in a managed template job document schema.

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

An example illustrating a pattern that need to be replaced in a managed template job document schema.

pub fn optional(&self) -> bool

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

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 copy 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

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 DocumentParameter