@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
187 lines (186 loc) • 8.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides an SSM Maintenance Window Target resource
*
* ## Example Usage
*
* ### Instance Target
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const window = new aws.ssm.MaintenanceWindow("window", {
* name: "maintenance-window-webapp",
* schedule: "cron(0 16 ? * TUE *)",
* duration: 3,
* cutoff: 1,
* });
* const target1 = new aws.ssm.MaintenanceWindowTarget("target1", {
* windowId: window.id,
* name: "maintenance-window-target",
* description: "This is a maintenance window target",
* resourceType: "INSTANCE",
* targets: [{
* key: "tag:Name",
* values: ["acceptance_test"],
* }],
* });
* ```
*
* ### Resource Group Target
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const window = new aws.ssm.MaintenanceWindow("window", {
* name: "maintenance-window-webapp",
* schedule: "cron(0 16 ? * TUE *)",
* duration: 3,
* cutoff: 1,
* });
* const target1 = new aws.ssm.MaintenanceWindowTarget("target1", {
* windowId: window.id,
* name: "maintenance-window-target",
* description: "This is a maintenance window target",
* resourceType: "RESOURCE_GROUP",
* targets: [{
* key: "resource-groups:ResourceTypeFilters",
* values: ["AWS::EC2::Instance"],
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import SSM Maintenance Window targets using `WINDOW_ID/WINDOW_TARGET_ID`. For example:
*
* ```sh
* $ pulumi import aws:ssm/maintenanceWindowTarget:MaintenanceWindowTarget example mw-0c50858d01EXAMPLE/23639a0b-ddbc-4bca-9e72-78d96EXAMPLE
* ```
*/
export declare class MaintenanceWindowTarget extends pulumi.CustomResource {
/**
* Get an existing MaintenanceWindowTarget resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MaintenanceWindowTargetState, opts?: pulumi.CustomResourceOptions): MaintenanceWindowTarget;
/**
* Returns true if the given object is an instance of MaintenanceWindowTarget. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MaintenanceWindowTarget;
/**
* The description of the maintenance window target.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the maintenance window target.
*/
readonly name: pulumi.Output<string>;
/**
* User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
*/
readonly ownerInformation: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* The type of target being registered with the Maintenance Window. Possible values are `INSTANCE` and `RESOURCE_GROUP`.
*/
readonly resourceType: pulumi.Output<string>;
/**
* The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see
* (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)
*/
readonly targets: pulumi.Output<outputs.ssm.MaintenanceWindowTargetTarget[]>;
/**
* The Id of the maintenance window to register the target with.
*/
readonly windowId: pulumi.Output<string>;
/**
* Create a MaintenanceWindowTarget resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MaintenanceWindowTargetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MaintenanceWindowTarget resources.
*/
export interface MaintenanceWindowTargetState {
/**
* The description of the maintenance window target.
*/
description?: pulumi.Input<string>;
/**
* The name of the maintenance window target.
*/
name?: pulumi.Input<string>;
/**
* User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
*/
ownerInformation?: 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>;
/**
* The type of target being registered with the Maintenance Window. Possible values are `INSTANCE` and `RESOURCE_GROUP`.
*/
resourceType?: pulumi.Input<string>;
/**
* The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see
* (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)
*/
targets?: pulumi.Input<pulumi.Input<inputs.ssm.MaintenanceWindowTargetTarget>[]>;
/**
* The Id of the maintenance window to register the target with.
*/
windowId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MaintenanceWindowTarget resource.
*/
export interface MaintenanceWindowTargetArgs {
/**
* The description of the maintenance window target.
*/
description?: pulumi.Input<string>;
/**
* The name of the maintenance window target.
*/
name?: pulumi.Input<string>;
/**
* User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
*/
ownerInformation?: 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>;
/**
* The type of target being registered with the Maintenance Window. Possible values are `INSTANCE` and `RESOURCE_GROUP`.
*/
resourceType: pulumi.Input<string>;
/**
* The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You can specify targets using instance IDs, resource group names, or tags that have been applied to instances. For more information about these examples formats see
* (https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html)
*/
targets: pulumi.Input<pulumi.Input<inputs.ssm.MaintenanceWindowTargetTarget>[]>;
/**
* The Id of the maintenance window to register the target with.
*/
windowId: pulumi.Input<string>;
}