1. Packages
  2. AWS Classic
  3. API Docs
  4. ssm
  5. PatchGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.ssm.PatchGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides an SSM Patch Group resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const production = new aws.ssm.PatchBaseline("production", {
        name: "patch-baseline",
        approvedPatches: ["KB123456"],
    });
    const patchgroup = new aws.ssm.PatchGroup("patchgroup", {
        baselineId: production.id,
        patchGroup: "patch-group-name",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    production = aws.ssm.PatchBaseline("production",
        name="patch-baseline",
        approved_patches=["KB123456"])
    patchgroup = aws.ssm.PatchGroup("patchgroup",
        baseline_id=production.id,
        patch_group="patch-group-name")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		production, err := ssm.NewPatchBaseline(ctx, "production", &ssm.PatchBaselineArgs{
    			Name: pulumi.String("patch-baseline"),
    			ApprovedPatches: pulumi.StringArray{
    				pulumi.String("KB123456"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ssm.NewPatchGroup(ctx, "patchgroup", &ssm.PatchGroupArgs{
    			BaselineId: production.ID(),
    			PatchGroup: pulumi.String("patch-group-name"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var production = new Aws.Ssm.PatchBaseline("production", new()
        {
            Name = "patch-baseline",
            ApprovedPatches = new[]
            {
                "KB123456",
            },
        });
    
        var patchgroup = new Aws.Ssm.PatchGroup("patchgroup", new()
        {
            BaselineId = production.Id,
            PatchGroupName = "patch-group-name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ssm.PatchBaseline;
    import com.pulumi.aws.ssm.PatchBaselineArgs;
    import com.pulumi.aws.ssm.PatchGroup;
    import com.pulumi.aws.ssm.PatchGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 production = new PatchBaseline("production", PatchBaselineArgs.builder()
                .name("patch-baseline")
                .approvedPatches("KB123456")
                .build());
    
            var patchgroup = new PatchGroup("patchgroup", PatchGroupArgs.builder()
                .baselineId(production.id())
                .patchGroup("patch-group-name")
                .build());
    
        }
    }
    
    resources:
      production:
        type: aws:ssm:PatchBaseline
        properties:
          name: patch-baseline
          approvedPatches:
            - KB123456
      patchgroup:
        type: aws:ssm:PatchGroup
        properties:
          baselineId: ${production.id}
          patchGroup: patch-group-name
    

    Create PatchGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PatchGroup(name: string, args: PatchGroupArgs, opts?: CustomResourceOptions);
    @overload
    def PatchGroup(resource_name: str,
                   args: PatchGroupArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def PatchGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   baseline_id: Optional[str] = None,
                   patch_group: Optional[str] = None)
    func NewPatchGroup(ctx *Context, name string, args PatchGroupArgs, opts ...ResourceOption) (*PatchGroup, error)
    public PatchGroup(string name, PatchGroupArgs args, CustomResourceOptions? opts = null)
    public PatchGroup(String name, PatchGroupArgs args)
    public PatchGroup(String name, PatchGroupArgs args, CustomResourceOptions options)
    
    type: aws:ssm:PatchGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PatchGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PatchGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PatchGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PatchGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PatchGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var patchGroupResource = new Aws.Ssm.PatchGroup("patchGroupResource", new()
    {
        BaselineId = "string",
        PatchGroupName = "string",
    });
    
    example, err := ssm.NewPatchGroup(ctx, "patchGroupResource", &ssm.PatchGroupArgs{
    	BaselineId: pulumi.String("string"),
    	PatchGroup: pulumi.String("string"),
    })
    
    var patchGroupResource = new PatchGroup("patchGroupResource", PatchGroupArgs.builder()
        .baselineId("string")
        .patchGroup("string")
        .build());
    
    patch_group_resource = aws.ssm.PatchGroup("patchGroupResource",
        baseline_id="string",
        patch_group="string")
    
    const patchGroupResource = new aws.ssm.PatchGroup("patchGroupResource", {
        baselineId: "string",
        patchGroup: "string",
    });
    
    type: aws:ssm:PatchGroup
    properties:
        baselineId: string
        patchGroup: string
    

    PatchGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PatchGroup resource accepts the following input properties:

    BaselineId string
    The ID of the patch baseline to register the patch group with.
    PatchGroupName string
    The name of the patch group that should be registered with the patch baseline.
    BaselineId string
    The ID of the patch baseline to register the patch group with.
    PatchGroup string
    The name of the patch group that should be registered with the patch baseline.
    baselineId String
    The ID of the patch baseline to register the patch group with.
    patchGroup String
    The name of the patch group that should be registered with the patch baseline.
    baselineId string
    The ID of the patch baseline to register the patch group with.
    patchGroup string
    The name of the patch group that should be registered with the patch baseline.
    baseline_id str
    The ID of the patch baseline to register the patch group with.
    patch_group str
    The name of the patch group that should be registered with the patch baseline.
    baselineId String
    The ID of the patch baseline to register the patch group with.
    patchGroup String
    The name of the patch group that should be registered with the patch baseline.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PatchGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PatchGroup Resource

    Get an existing PatchGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PatchGroupState, opts?: CustomResourceOptions): PatchGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            baseline_id: Optional[str] = None,
            patch_group: Optional[str] = None) -> PatchGroup
    func GetPatchGroup(ctx *Context, name string, id IDInput, state *PatchGroupState, opts ...ResourceOption) (*PatchGroup, error)
    public static PatchGroup Get(string name, Input<string> id, PatchGroupState? state, CustomResourceOptions? opts = null)
    public static PatchGroup get(String name, Output<String> id, PatchGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BaselineId string
    The ID of the patch baseline to register the patch group with.
    PatchGroupName string
    The name of the patch group that should be registered with the patch baseline.
    BaselineId string
    The ID of the patch baseline to register the patch group with.
    PatchGroup string
    The name of the patch group that should be registered with the patch baseline.
    baselineId String
    The ID of the patch baseline to register the patch group with.
    patchGroup String
    The name of the patch group that should be registered with the patch baseline.
    baselineId string
    The ID of the patch baseline to register the patch group with.
    patchGroup string
    The name of the patch group that should be registered with the patch baseline.
    baseline_id str
    The ID of the patch baseline to register the patch group with.
    patch_group str
    The name of the patch group that should be registered with the patch baseline.
    baselineId String
    The ID of the patch baseline to register the patch group with.
    patchGroup String
    The name of the patch group that should be registered with the patch baseline.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi