Class MaintenanceWindowTarget


  • public class MaintenanceWindowTarget
    extends com.pulumi.resources.CustomResource
    Provides an SSM Maintenance Window Target resource ## Example Usage ### Instance Target
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssm.MaintenanceWindow;
     import com.pulumi.aws.ssm.MaintenanceWindowArgs;
     import com.pulumi.aws.ssm.MaintenanceWindowTarget;
     import com.pulumi.aws.ssm.MaintenanceWindowTargetArgs;
     import com.pulumi.aws.ssm.inputs.MaintenanceWindowTargetTargetArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var window = new MaintenanceWindow("window", MaintenanceWindowArgs.builder()
                 .name("maintenance-window-webapp")
                 .schedule("cron(0 16 ? * TUE *)")
                 .duration(3)
                 .cutoff(1)
                 .build());
     
             var target1 = new MaintenanceWindowTarget("target1", MaintenanceWindowTargetArgs.builder()
                 .targets(MaintenanceWindowTargetTargetArgs.builder()
                     .key("tag:Name")
                     .values("acceptance_test")
                     .build())
                 .windowId(window.id())
                 .name("maintenance-window-target")
                 .description("This is a maintenance window target")
                 .resourceType("INSTANCE")
                 .build());
     
         }
     }
     
     
    ### Resource Group Target
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssm.MaintenanceWindow;
     import com.pulumi.aws.ssm.MaintenanceWindowArgs;
     import com.pulumi.aws.ssm.MaintenanceWindowTarget;
     import com.pulumi.aws.ssm.MaintenanceWindowTargetArgs;
     import com.pulumi.aws.ssm.inputs.MaintenanceWindowTargetTargetArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var window = new MaintenanceWindow("window", MaintenanceWindowArgs.builder()
                 .name("maintenance-window-webapp")
                 .schedule("cron(0 16 ? * TUE *)")
                 .duration(3)
                 .cutoff(1)
                 .build());
     
             var target1 = new MaintenanceWindowTarget("target1", MaintenanceWindowTargetArgs.builder()
                 .targets(MaintenanceWindowTargetTargetArgs.builder()
                     .key("resource-groups:ResourceTypeFilters")
                     .values("AWS::EC2::Instance")
                     .build())
                 .windowId(window.id())
                 .name("maintenance-window-target")
                 .description("This is a maintenance window target")
                 .resourceType("RESOURCE_GROUP")
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `windowId` - (String) ID of the maintenance window. * `id` - (String) ID of the maintenance window target. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. 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 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static MaintenanceWindowTarget get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MaintenanceWindowTargetState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ownerInformation()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceType()  
      com.pulumi.core.Output<java.util.List<MaintenanceWindowTargetTarget>> targets()  
      com.pulumi.core.Output<java.lang.String> windowId()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MaintenanceWindowTarget

        public MaintenanceWindowTarget​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • MaintenanceWindowTarget

        public MaintenanceWindowTarget​(java.lang.String name,
                                       MaintenanceWindowTargetArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • MaintenanceWindowTarget

        public MaintenanceWindowTarget​(java.lang.String name,
                                       MaintenanceWindowTargetArgs args,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the maintenance window target.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the maintenance window target.
      • ownerInformation

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ownerInformation()
        Returns:
        User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.
      • resourceType

        public com.pulumi.core.Output<java.lang.String> resourceType()
        Returns:
        The type of target being registered with the Maintenance Window. Possible values are `INSTANCE` and `RESOURCE_GROUP`.
      • targets

        public com.pulumi.core.Output<java.util.List<MaintenanceWindowTargetTarget>> targets()
        Returns:
        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)
      • windowId

        public com.pulumi.core.Output<java.lang.String> windowId()
        Returns:
        The ID of the maintenance window to register the target with.
      • get

        public static MaintenanceWindowTarget get​(java.lang.String name,
                                                  com.pulumi.core.Output<java.lang.String> id,
                                                  @Nullable
                                                  MaintenanceWindowTargetState state,
                                                  @Nullable
                                                  com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.