« blib/lib/Paws/SSM/RegisterPatchBaselineForPatchGroupResult.pm
↑ Summary
blib/lib/Paws/SSM/RegisterTargetWithMaintenanceWindowResult.pm »
| 1 | |||
| 2 | package Paws::SSM::RegisterTargetWithMaintenanceWindow; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str'); | ||
| 7 | has OwnerInformation => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResourceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]', required => 1); | ||
| 10 | has WindowId => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterTargetWithMaintenanceWindow'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::RegisterTargetWithMaintenanceWindowResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SSM::RegisterTargetWithMaintenanceWindow - Arguments for method RegisterTargetWithMaintenanceWindow on L<Paws::SSM> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method RegisterTargetWithMaintenanceWindow on the | ||
| 28 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 29 | as arguments to method RegisterTargetWithMaintenanceWindow. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterTargetWithMaintenanceWindow. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ssm = Paws->service('SSM'); | ||
| 36 | my $RegisterTargetWithMaintenanceWindowResult = | ||
| 37 | $ssm->RegisterTargetWithMaintenanceWindow( | ||
| 38 | ResourceType => 'INSTANCE', | ||
| 39 | Targets => [ | ||
| 40 | { | ||
| 41 | Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL | ||
| 42 | Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], | ||
| 46 | WindowId => 'MyMaintenanceWindowId', | ||
| 47 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 48 | Description => 'MyMaintenanceWindowDescription', # OPTIONAL | ||
| 49 | Name => 'MyMaintenanceWindowName', # OPTIONAL | ||
| 50 | OwnerInformation => 'MyOwnerInformation', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $WindowTargetId = | ||
| 55 | $RegisterTargetWithMaintenanceWindowResult->WindowTargetId; | ||
| 56 | |||
| 57 | # Returns a L<Paws::SSM::RegisterTargetWithMaintenanceWindowResult> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/RegisterTargetWithMaintenanceWindow> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 ClientToken => Str | ||
| 66 | |||
| 67 | User-provided idempotency token. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Description => Str | ||
| 72 | |||
| 73 | An optional description for the target. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 Name => Str | ||
| 78 | |||
| 79 | An optional name for the target. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 OwnerInformation => Str | ||
| 84 | |||
| 85 | User-provided value that will be included in any CloudWatch events | ||
| 86 | raised while running tasks for these targets in this maintenance | ||
| 87 | window. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> ResourceType => Str | ||
| 92 | |||
| 93 | The type of target being registered with the maintenance window. | ||
| 94 | |||
| 95 | Valid values are: C<"INSTANCE">, C<"RESOURCE_GROUP"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 98 | |||
| 99 | The targets to register with the maintenance window. In other words, | ||
| 100 | the instances to run commands on when the maintenance window runs. | ||
| 101 | |||
| 102 | If a single maintenance window task is registered with multiple | ||
| 103 | targets, its task invocations occur sequentially and not in parallel. | ||
| 104 | If your task must run on multiple targets at the same time, register a | ||
| 105 | task for each target individually and assign each task the same | ||
| 106 | priority level. | ||
| 107 | |||
| 108 | You can specify targets using instance IDs, resource group names, or | ||
| 109 | tags that have been applied to instances. | ||
| 110 | |||
| 111 | B<Example 1>: Specify instance IDs | ||
| 112 | |||
| 113 | C<Key=InstanceIds,Values=I<instance-id-1>,I<instance-id-2>,I<instance-id-3>> | ||
| 114 | |||
| 115 | B<Example 2>: Use tag key-pairs applied to instances | ||
| 116 | |||
| 117 | C<Key=tag:I<my-tag-key>,Values=I<my-tag-value-1>,I<my-tag-value-2>> | ||
| 118 | |||
| 119 | B<Example 3>: Use tag-keys applied to instances | ||
| 120 | |||
| 121 | C<Key=tag-key,Values=I<my-tag-key-1>,I<my-tag-key-2>> | ||
| 122 | |||
| 123 | B<Example 4>: Use resource group names | ||
| 124 | |||
| 125 | C<Key=resource-groups:Name,Values=I<resource-group-name>> | ||
| 126 | |||
| 127 | B<Example 5>: Use filters for resource group types | ||
| 128 | |||
| 129 | C<Key=resource-groups:ResourceTypeFilters,Values=I<resource-type-1>,I<resource-type-2>> | ||
| 130 | |||
| 131 | For C<Key=resource-groups:ResourceTypeFilters>, specify resource types | ||
| 132 | in the following format | ||
| 133 | |||
| 134 | C<Key=resource-groups:ResourceTypeFilters,Values=I<AWS::EC2::INSTANCE>,I<AWS::EC2::VPC>> | ||
| 135 | |||
| 136 | For more information about these examples formats, including the best | ||
| 137 | use case for each one, see Examples: Register targets with a | ||
| 138 | maintenance window | ||
| 139 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html) | ||
| 140 | in the I<AWS Systems Manager User Guide>. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 B<REQUIRED> WindowId => Str | ||
| 145 | |||
| 146 | The ID of the maintenance window the target should be registered with. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, documenting arguments for method RegisterTargetWithMaintenanceWindow in L<Paws::SSM> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |