/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SSM::CreateActivation

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ssm = Paws->service('SSM');
my $CreateActivationResult = $ssm->CreateActivation(
  IamRole             => 'MyIamRole',
  DefaultInstanceName => 'MyDefaultInstanceName',      # OPTIONAL
  Description         => 'MyActivationDescription',    # OPTIONAL
  ExpirationDate      => '1970-01-01T01:00:00',        # OPTIONAL
  RegistrationLimit   => 1,                            # OPTIONAL
  Tags                => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128
      Value => 'MyTagValue',    # min: 1, max: 256

    },
    ...
  ],    # OPTIONAL
);

# Results:
my $ActivationCode = $CreateActivationResult->ActivationCode;
my $ActivationId   = $CreateActivationResult->ActivationId;

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

ATTRIBUTES

DefaultInstanceName => Str

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Description => Str

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

ExpirationDate => Str

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

REQUIRED IamRole => Str

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html) in the AWS Systems Manager User Guide.

RegistrationLimit => Int

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

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 activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateActivation 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