/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::SSM::CreateDocument

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ssm = Paws->service('SSM');
my $CreateDocumentResult = $ssm->CreateDocument(
  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
  DocumentFormat => 'YAML',       # OPTIONAL
  DocumentType   => 'Command',    # OPTIONAL
  Requires       => [
    {
      Name    => 'MyDocumentARN',
      Version => 'MyDocumentVersion',    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
  TargetType  => 'MyTargetType',             # OPTIONAL
  VersionName => 'MyDocumentVersionName',    # OPTIONAL
);

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

# Returns a L<Paws::SSM::CreateDocumentResult> 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/CreateDocument

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.

DocumentFormat => Str

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

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

DocumentType => Str

The type of document to create.

Valid values are: "Command", "Policy", "Automation", "Session", "Package", "ApplicationConfiguration", "ApplicationConfigurationSchema", "DeploymentStrategy", "ChangeCalendar"

REQUIRED Name => Str

A name for the Systems Manager document.

Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

  • aws

  • amazon

  • amzn

Requires => ArrayRef[Paws::SSM::DocumentRequires]

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Tags => ArrayRef[Paws::SSM::Tag]

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource action.

TargetType => Str

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the AWS CloudFormation User Guide.

VersionName => Str

An optional field specifying the version of the artifact you are creating 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 CreateDocument 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