Amazonka.SSM.Types.Parameter

Documentation

data Parameter

An Amazon Web Services Systems Manager parameter in Parameter Store.

See: newParameter smart constructor.

Constructors

Parameter'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the parameter.

• dataType :: Maybe Text

  The data type of the parameter, such as text or aws:ec2:image. The default is text.

• lastModifiedDate :: Maybe POSIX

  Date the parameter was last changed or updated and the parameter version was created.

• selector :: Maybe Text

  Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

  parameter_name:version

  parameter_name:label

• sourceResult :: Maybe Text

  Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

• name :: Text

  The name of the parameter.

• type' :: ParameterType

  The type of parameter. Valid values include the following: String, StringList, and SecureString.

  If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

• value :: Sensitive Text

  The parameter value.

  If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

• version :: Integer

  The parameter version.

Instances

FromJSON Parameter

Defined in Amazonka.SSM.Types.Parameter

Methods

parseJSON :: Value -> Parser Parameter

parseJSONList :: Value -> Parser [Parameter]

Generic Parameter

Defined in Amazonka.SSM.Types.Parameter

Associated Types

type Rep Parameter :: Type -> Type

Methods

from :: Parameter -> Rep Parameter x

to :: Rep Parameter x -> Parameter

Show Parameter

Defined in Amazonka.SSM.Types.Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

NFData Parameter

Defined in Amazonka.SSM.Types.Parameter

Methods

rnf :: Parameter -> ()

Eq Parameter

Defined in Amazonka.SSM.Types.Parameter

Methods

(==) :: Parameter -> Parameter -> Bool

(/=) :: Parameter -> Parameter -> Bool

Hashable Parameter

Defined in Amazonka.SSM.Types.Parameter

Methods

hashWithSalt :: Int -> Parameter -> Int

hash :: Parameter -> Int

type Rep Parameter

Defined in Amazonka.SSM.Types.Parameter

type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.SSM.Types.Parameter" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "selector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ParameterType) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))))

newParameter

Arguments

:: Text

$sel:name:Parameter'

-> ParameterType

$sel:type':Parameter'

-> Text

$sel:value:Parameter'

-> Integer

$sel:version:Parameter'

-> Parameter

Create a value of Parameter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Parameter', parameter_arn - The Amazon Resource Name (ARN) of the parameter.

$sel:dataType:Parameter', parameter_dataType - The data type of the parameter, such as text or aws:ec2:image. The default is text.

$sel:lastModifiedDate:Parameter', parameter_lastModifiedDate - Date the parameter was last changed or updated and the parameter version was created.

$sel:selector:Parameter', parameter_selector - Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

$sel:sourceResult:Parameter', parameter_sourceResult - Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

$sel:name:Parameter', parameter_name - The name of the parameter.

$sel:type':Parameter', parameter_type - The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

$sel:value:Parameter', parameter_value - The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

$sel:version:Parameter', parameter_version - The parameter version.

parameter_arn :: Lens' Parameter (Maybe Text)

The Amazon Resource Name (ARN) of the parameter.

parameter_dataType :: Lens' Parameter (Maybe Text)

The data type of the parameter, such as text or aws:ec2:image. The default is text.

parameter_lastModifiedDate :: Lens' Parameter (Maybe UTCTime)

Date the parameter was last changed or updated and the parameter version was created.

parameter_selector :: Lens' Parameter (Maybe Text)

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

parameter_sourceResult :: Lens' Parameter (Maybe Text)

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

parameter_name :: Lens' Parameter Text

The name of the parameter.

parameter_type :: Lens' Parameter ParameterType

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

parameter_value :: Lens' Parameter Text

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

parameter_version :: Lens' Parameter Integer

The parameter version.