The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::SSM::UpdateDocument - Arguments for method UpdateDocument on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method UpdateDocument on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method UpdateDocument.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDocument.

SYNOPSIS

    my $ssm = Paws->service('SSM');
    my $UpdateDocumentResult = $ssm->UpdateDocument(
      Content     => 'MyDocumentContent',
      Name        => 'MyDocumentName',
      Attachments => [
        {
          Key => 'SourceUrl'
          ,    # values: SourceUrl, S3FileUrl, AttachmentReference; OPTIONAL
          Name   => 'MyAttachmentIdentifier',    # OPTIONAL
          Values => [
            'MyAttachmentsSourceValue', ...      # min: 1, max: 1024
          ],    # min: 1, max: 1; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      DisplayName     => 'MyDocumentDisplayName',    # OPTIONAL
      DocumentFormat  => 'YAML',                     # OPTIONAL
      DocumentVersion => 'MyDocumentVersion',        # OPTIONAL
      TargetType      => 'MyTargetType',             # OPTIONAL
      VersionName     => 'MyDocumentVersionName',    # OPTIONAL
    );

    # Results:
    my $DocumentDescription = $UpdateDocumentResult->DocumentDescription;

    # Returns a L<Paws::SSM::UpdateDocumentResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateDocument

ATTRIBUTES

Attachments => ArrayRef[Paws::SSM::AttachmentsSource]

A list of key and value pairs that describe attachments to a version of a document.

REQUIRED Content => Str

A valid JSON or YAML string.

DisplayName => Str

The friendly name of the Systems Manager document that you want to update. This value can differ for each version of the document. If you do not specify a value for this parameter in your request, the existing value is applied to the new document version.

DocumentFormat => Str

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Valid values are: "YAML", "JSON", "TEXT"

DocumentVersion => Str

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

REQUIRED Name => Str

The name of the Systems Manager document that you want to update.

TargetType => Str

Specify a new target type for the document.

VersionName => Str

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateDocument in Paws::SSM

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues