@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
185 lines (184 loc) • 6.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Provides an SSM Patch Baseline data source. Useful if you wish to reuse the default baselines provided.
*
* ## Example Usage
*
* To retrieve a baseline provided by AWS:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const centos = aws.ssm.getPatchBaseline({
* owner: "AWS",
* namePrefix: "AWS-",
* operatingSystem: "CENTOS",
* });
* ```
*
* To retrieve a baseline on your account:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const defaultCustom = aws.ssm.getPatchBaseline({
* owner: "Self",
* namePrefix: "MyCustomBaseline",
* defaultBaseline: true,
* operatingSystem: "WINDOWS",
* });
* ```
*/
export declare function getPatchBaseline(args: GetPatchBaselineArgs, opts?: pulumi.InvokeOptions): Promise<GetPatchBaselineResult>;
/**
* A collection of arguments for invoking getPatchBaseline.
*/
export interface GetPatchBaselineArgs {
/**
* Filters the results against the baselines defaultBaseline field.
*/
defaultBaseline?: boolean;
/**
* Filter results by the baseline name prefix.
*/
namePrefix?: string;
/**
* Specified OS for the baseline. Valid values: `AMAZON_LINUX`, `AMAZON_LINUX_2`, `UBUNTU`, `REDHAT_ENTERPRISE_LINUX`, `SUSE`, `CENTOS`, `ORACLE_LINUX`, `DEBIAN`, `MACOS`, `RASPBIAN` and `ROCKY_LINUX`.
*/
operatingSystem?: string;
/**
* Owner of the baseline. Valid values: `All`, `AWS`, `Self` (the current account).
*
* The following arguments are optional:
*/
owner: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
}
/**
* A collection of values returned by getPatchBaseline.
*/
export interface GetPatchBaselineResult {
/**
* List of rules used to include patches in the baseline.
*/
readonly approvalRules: outputs.ssm.GetPatchBaselineApprovalRule[];
/**
* List of explicitly approved patches for the baseline.
*/
readonly approvedPatches: string[];
/**
* Compliance level for approved patches.
*/
readonly approvedPatchesComplianceLevel: string;
/**
* Indicates whether the list of approved patches includes non-security updates that should be applied to the instances.
*/
readonly approvedPatchesEnableNonSecurity: boolean;
/**
* Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only.
*/
readonly availableSecurityUpdatesComplianceStatus: string;
readonly defaultBaseline?: boolean;
/**
* Description of the baseline.
*/
readonly description: string;
/**
* Set of global filters used to exclude patches from the baseline.
*/
readonly globalFilters: outputs.ssm.GetPatchBaselineGlobalFilter[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* JSON representation of the baseline.
*/
readonly json: string;
/**
* Name specified to identify the patch source.
*/
readonly name: string;
readonly namePrefix?: string;
readonly operatingSystem?: string;
readonly owner: string;
readonly region: string;
/**
* List of rejected patches.
*/
readonly rejectedPatches: string[];
/**
* Action specified to take on patches included in the `rejectedPatches` list.
*/
readonly rejectedPatchesAction: string;
/**
* Information about the patches to use to update the managed nodes, including target operating systems and source repositories.
*/
readonly sources: outputs.ssm.GetPatchBaselineSource[];
}
/**
* Provides an SSM Patch Baseline data source. Useful if you wish to reuse the default baselines provided.
*
* ## Example Usage
*
* To retrieve a baseline provided by AWS:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const centos = aws.ssm.getPatchBaseline({
* owner: "AWS",
* namePrefix: "AWS-",
* operatingSystem: "CENTOS",
* });
* ```
*
* To retrieve a baseline on your account:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const defaultCustom = aws.ssm.getPatchBaseline({
* owner: "Self",
* namePrefix: "MyCustomBaseline",
* defaultBaseline: true,
* operatingSystem: "WINDOWS",
* });
* ```
*/
export declare function getPatchBaselineOutput(args: GetPatchBaselineOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPatchBaselineResult>;
/**
* A collection of arguments for invoking getPatchBaseline.
*/
export interface GetPatchBaselineOutputArgs {
/**
* Filters the results against the baselines defaultBaseline field.
*/
defaultBaseline?: pulumi.Input<boolean>;
/**
* Filter results by the baseline name prefix.
*/
namePrefix?: pulumi.Input<string>;
/**
* Specified OS for the baseline. Valid values: `AMAZON_LINUX`, `AMAZON_LINUX_2`, `UBUNTU`, `REDHAT_ENTERPRISE_LINUX`, `SUSE`, `CENTOS`, `ORACLE_LINUX`, `DEBIAN`, `MACOS`, `RASPBIAN` and `ROCKY_LINUX`.
*/
operatingSystem?: pulumi.Input<string>;
/**
* Owner of the baseline. Valid values: `All`, `AWS`, `Self` (the current account).
*
* The following arguments are optional:
*/
owner: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}