« blib/lib/Paws/SSM/CreateOpsMetadataResult.pm
↑ Summary
blib/lib/Paws/SSM/CreatePatchBaselineResult.pm »
| 1 | |||
| 2 | package Paws::SSM::CreatePatchBaseline; | ||
| 3 | use Moose; | ||
| 4 | has ApprovalRules => (is => 'ro', isa => 'Paws::SSM::PatchRuleGroup'); | ||
| 5 | has ApprovedPatches => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has ApprovedPatchesComplianceLevel => (is => 'ro', isa => 'Str'); | ||
| 7 | has ApprovedPatchesEnableNonSecurity => (is => 'ro', isa => 'Bool'); | ||
| 8 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has Description => (is => 'ro', isa => 'Str'); | ||
| 10 | has GlobalFilters => (is => 'ro', isa => 'Paws::SSM::PatchFilterGroup'); | ||
| 11 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has OperatingSystem => (is => 'ro', isa => 'Str'); | ||
| 13 | has RejectedPatches => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has RejectedPatchesAction => (is => 'ro', isa => 'Str'); | ||
| 15 | has Sources => (is => 'ro', isa => 'ArrayRef[Paws::SSM::PatchSource]'); | ||
| 16 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePatchBaseline'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::CreatePatchBaselineResult'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::SSM::CreatePatchBaseline - Arguments for method CreatePatchBaseline on L<Paws::SSM> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreatePatchBaseline on the | ||
| 34 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 35 | as arguments to method CreatePatchBaseline. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePatchBaseline. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $ssm = Paws->service('SSM'); | ||
| 42 | my $CreatePatchBaselineResult = $ssm->CreatePatchBaseline( | ||
| 43 | Name => 'MyBaselineName', | ||
| 44 | ApprovalRules => { | ||
| 45 | PatchRules => [ | ||
| 46 | { | ||
| 47 | PatchFilterGroup => { | ||
| 48 | PatchFilters => [ | ||
| 49 | { | ||
| 50 | Key => 'ARCH' | ||
| 51 | , # values: ARCH, ADVISORY_ID, BUGZILLA_ID, PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, CVE_ID, EPOCH, MSRC_SEVERITY, NAME, PATCH_ID, SECTION, PRIORITY, REPOSITORY, RELEASE, SEVERITY, SECURITY, VERSION | ||
| 52 | Values => [ | ||
| 53 | 'MyPatchFilterValue', ... # min: 1, max: 64 | ||
| 54 | ], # min: 1, max: 20 | ||
| 55 | |||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # max: 4 | ||
| 59 | |||
| 60 | }, | ||
| 61 | ApproveAfterDays => 1, # max: 360; OPTIONAL | ||
| 62 | ApproveUntilDate => | ||
| 63 | 'MyPatchStringDateTime', # min: 1, max: 10; OPTIONAL | ||
| 64 | ComplianceLevel => 'CRITICAL' | ||
| 65 | , # values: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED; OPTIONAL | ||
| 66 | EnableNonSecurity => 1, # OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # max: 10 | ||
| 70 | |||
| 71 | }, # OPTIONAL | ||
| 72 | ApprovedPatches => [ | ||
| 73 | 'MyPatchId', ... # min: 1, max: 100 | ||
| 74 | ], # OPTIONAL | ||
| 75 | ApprovedPatchesComplianceLevel => 'CRITICAL', # OPTIONAL | ||
| 76 | ApprovedPatchesEnableNonSecurity => 1, # OPTIONAL | ||
| 77 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 78 | Description => 'MyBaselineDescription', # OPTIONAL | ||
| 79 | GlobalFilters => { | ||
| 80 | PatchFilters => [ | ||
| 81 | { | ||
| 82 | Key => 'ARCH' | ||
| 83 | , # values: ARCH, ADVISORY_ID, BUGZILLA_ID, PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, CVE_ID, EPOCH, MSRC_SEVERITY, NAME, PATCH_ID, SECTION, PRIORITY, REPOSITORY, RELEASE, SEVERITY, SECURITY, VERSION | ||
| 84 | Values => [ | ||
| 85 | 'MyPatchFilterValue', ... # min: 1, max: 64 | ||
| 86 | ], # min: 1, max: 20 | ||
| 87 | |||
| 88 | }, | ||
| 89 | ... | ||
| 90 | ], # max: 4 | ||
| 91 | |||
| 92 | }, # OPTIONAL | ||
| 93 | OperatingSystem => 'WINDOWS', # OPTIONAL | ||
| 94 | RejectedPatches => [ | ||
| 95 | 'MyPatchId', ... # min: 1, max: 100 | ||
| 96 | ], # OPTIONAL | ||
| 97 | RejectedPatchesAction => 'ALLOW_AS_DEPENDENCY', # OPTIONAL | ||
| 98 | Sources => [ | ||
| 99 | { | ||
| 100 | Configuration => 'MyPatchSourceConfiguration', # min: 1, max: 1024 | ||
| 101 | Name => 'MyPatchSourceName', | ||
| 102 | Products => [ | ||
| 103 | 'MyPatchSourceProduct', ... # min: 1, max: 128 | ||
| 104 | ], # min: 1, max: 20 | ||
| 105 | |||
| 106 | }, | ||
| 107 | ... | ||
| 108 | ], # OPTIONAL | ||
| 109 | Tags => [ | ||
| 110 | { | ||
| 111 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 112 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 113 | |||
| 114 | }, | ||
| 115 | ... | ||
| 116 | ], # OPTIONAL | ||
| 117 | ); | ||
| 118 | |||
| 119 | # Results: | ||
| 120 | my $BaselineId = $CreatePatchBaselineResult->BaselineId; | ||
| 121 | |||
| 122 | # Returns a L<Paws::SSM::CreatePatchBaselineResult> object. | ||
| 123 | |||
| 124 | 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. | ||
| 125 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/CreatePatchBaseline> | ||
| 126 | |||
| 127 | =head1 ATTRIBUTES | ||
| 128 | |||
| 129 | |||
| 130 | =head2 ApprovalRules => L<Paws::SSM::PatchRuleGroup> | ||
| 131 | |||
| 132 | A set of rules used to include patches in the baseline. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 ApprovedPatches => ArrayRef[Str|Undef] | ||
| 137 | |||
| 138 | A list of explicitly approved patches for the baseline. | ||
| 139 | |||
| 140 | For information about accepted formats for lists of approved patches | ||
| 141 | and rejected patches, see About package name formats for approved and | ||
| 142 | rejected patch lists | ||
| 143 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) | ||
| 144 | in the I<AWS Systems Manager User Guide>. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 ApprovedPatchesComplianceLevel => Str | ||
| 149 | |||
| 150 | Defines the compliance level for approved patches. When an approved | ||
| 151 | patch is reported as missing, this value describes the severity of the | ||
| 152 | compliance violation. The default value is UNSPECIFIED. | ||
| 153 | |||
| 154 | Valid values are: C<"CRITICAL">, C<"HIGH">, C<"MEDIUM">, C<"LOW">, C<"INFORMATIONAL">, C<"UNSPECIFIED"> | ||
| 155 | |||
| 156 | =head2 ApprovedPatchesEnableNonSecurity => Bool | ||
| 157 | |||
| 158 | Indicates whether the list of approved patches includes non-security | ||
| 159 | updates that should be applied to the instances. The default value is | ||
| 160 | 'false'. Applies to Linux instances only. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 ClientToken => Str | ||
| 165 | |||
| 166 | User-provided idempotency token. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 Description => Str | ||
| 171 | |||
| 172 | A description of the patch baseline. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head2 GlobalFilters => L<Paws::SSM::PatchFilterGroup> | ||
| 177 | |||
| 178 | A set of global filters used to include patches in the baseline. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 B<REQUIRED> Name => Str | ||
| 183 | |||
| 184 | The name of the patch baseline. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 OperatingSystem => Str | ||
| 189 | |||
| 190 | Defines the operating system the patch baseline applies to. The Default | ||
| 191 | value is WINDOWS. | ||
| 192 | |||
| 193 | Valid values are: C<"WINDOWS">, C<"AMAZON_LINUX">, C<"AMAZON_LINUX_2">, C<"UBUNTU">, C<"REDHAT_ENTERPRISE_LINUX">, C<"SUSE">, C<"CENTOS">, C<"ORACLE_LINUX">, C<"DEBIAN">, C<"MACOS"> | ||
| 194 | |||
| 195 | =head2 RejectedPatches => ArrayRef[Str|Undef] | ||
| 196 | |||
| 197 | A list of explicitly rejected patches for the baseline. | ||
| 198 | |||
| 199 | For information about accepted formats for lists of approved patches | ||
| 200 | and rejected patches, see About package name formats for approved and | ||
| 201 | rejected patch lists | ||
| 202 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) | ||
| 203 | in the I<AWS Systems Manager User Guide>. | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 RejectedPatchesAction => Str | ||
| 208 | |||
| 209 | The action for Patch Manager to take on patches included in the | ||
| 210 | RejectedPackages list. | ||
| 211 | |||
| 212 | =over | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | B<ALLOW_AS_DEPENDENCY>: A package in the Rejected patches list is | ||
| 217 | installed only if it is a dependency of another package. It is | ||
| 218 | considered compliant with the patch baseline, and its status is | ||
| 219 | reported as I<InstalledOther>. This is the default action if no option | ||
| 220 | is specified. | ||
| 221 | |||
| 222 | =item * | ||
| 223 | |||
| 224 | B<BLOCK>: Packages in the RejectedPatches list, and packages that | ||
| 225 | include them as dependencies, are not installed under any | ||
| 226 | circumstances. If a package was installed before it was added to the | ||
| 227 | Rejected patches list, it is considered non-compliant with the patch | ||
| 228 | baseline, and its status is reported as I<InstalledRejected>. | ||
| 229 | |||
| 230 | =back | ||
| 231 | |||
| 232 | |||
| 233 | Valid values are: C<"ALLOW_AS_DEPENDENCY">, C<"BLOCK"> | ||
| 234 | |||
| 235 | =head2 Sources => ArrayRef[L<Paws::SSM::PatchSource>] | ||
| 236 | |||
| 237 | Information about the patches to use to update the instances, including | ||
| 238 | target operating systems and source repositories. Applies to Linux | ||
| 239 | instances only. | ||
| 240 | |||
| 241 | |||
| 242 | |||
| 243 | =head2 Tags => ArrayRef[L<Paws::SSM::Tag>] | ||
| 244 | |||
| 245 | Optional metadata that you assign to a resource. Tags enable you to | ||
| 246 | categorize a resource in different ways, such as by purpose, owner, or | ||
| 247 | environment. For example, you might want to tag a patch baseline to | ||
| 248 | identify the severity level of patches it specifies and the operating | ||
| 249 | system family it applies to. In this case, you could specify the | ||
| 250 | following key name/value pairs: | ||
| 251 | |||
| 252 | =over | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | C<Key=PatchSeverity,Value=Critical> | ||
| 257 | |||
| 258 | =item * | ||
| 259 | |||
| 260 | C<Key=OS,Value=Windows> | ||
| 261 | |||
| 262 | =back | ||
| 263 | |||
| 264 | To add tags to an existing patch baseline, use the AddTagsToResource | ||
| 265 | action. | ||
| 266 | |||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | =head1 SEE ALSO | ||
| 271 | |||
| 272 | This class forms part of L<Paws>, documenting arguments for method CreatePatchBaseline in L<Paws::SSM> | ||
| 273 | |||
| 274 | =head1 BUGS and CONTRIBUTIONS | ||
| 275 | |||
| 276 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 277 | |||
| 278 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 279 | |||
| 280 | =cut | ||
| 281 |