Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ssm
  5. Association
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.ssm.Association

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Associates an SSM Document to an instance or EC2 tag.

Example Usage

Create an association for a specific instance

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssm.Association("example", {
    name: exampleAwsSsmDocument.name,
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.Association("example",
    name=example_aws_ssm_document["name"],
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }])
Copy
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 {
		_, err := ssm.NewAssociation(ctx, "example", &ssm.AssociationArgs{
			Name: pulumi.Any(exampleAwsSsmDocument.Name),
			Targets: ssm.AssociationTargetArray{
				&ssm.AssociationTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.Association("example", new()
    {
        Name = exampleAwsSsmDocument.Name,
        Targets = new[]
        {
            new Aws.Ssm.Inputs.AssociationTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Association;
import com.pulumi.aws.ssm.AssociationArgs;
import com.pulumi.aws.ssm.inputs.AssociationTargetArgs;
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 example = new Association("example", AssociationArgs.builder()
            .name(exampleAwsSsmDocument.name())
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:Association
    properties:
      name: ${exampleAwsSsmDocument.name}
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
Copy

Create an association for all managed instances in an AWS account

To target all managed instances in an AWS account, set the key as "InstanceIds" with values set as ["*"]. This example also illustrates how to use an Amazon owned SSM document named AmazonCloudWatch-ManageAgent.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssm.Association("example", {
    name: "AmazonCloudWatch-ManageAgent",
    targets: [{
        key: "InstanceIds",
        values: ["*"],
    }],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.Association("example",
    name="AmazonCloudWatch-ManageAgent",
    targets=[{
        "key": "InstanceIds",
        "values": ["*"],
    }])
Copy
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 {
		_, err := ssm.NewAssociation(ctx, "example", &ssm.AssociationArgs{
			Name: pulumi.String("AmazonCloudWatch-ManageAgent"),
			Targets: ssm.AssociationTargetArray{
				&ssm.AssociationTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						pulumi.String("*"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.Association("example", new()
    {
        Name = "AmazonCloudWatch-ManageAgent",
        Targets = new[]
        {
            new Aws.Ssm.Inputs.AssociationTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    "*",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Association;
import com.pulumi.aws.ssm.AssociationArgs;
import com.pulumi.aws.ssm.inputs.AssociationTargetArgs;
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 example = new Association("example", AssociationArgs.builder()
            .name("AmazonCloudWatch-ManageAgent")
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values("*")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:Association
    properties:
      name: AmazonCloudWatch-ManageAgent
      targets:
        - key: InstanceIds
          values:
            - '*'
Copy

Create an association for a specific tag

This example shows how to target all managed instances that are assigned a tag key of Environment and value of Development.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssm.Association("example", {
    name: "AmazonCloudWatch-ManageAgent",
    targets: [{
        key: "tag:Environment",
        values: ["Development"],
    }],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.Association("example",
    name="AmazonCloudWatch-ManageAgent",
    targets=[{
        "key": "tag:Environment",
        "values": ["Development"],
    }])
Copy
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 {
		_, err := ssm.NewAssociation(ctx, "example", &ssm.AssociationArgs{
			Name: pulumi.String("AmazonCloudWatch-ManageAgent"),
			Targets: ssm.AssociationTargetArray{
				&ssm.AssociationTargetArgs{
					Key: pulumi.String("tag:Environment"),
					Values: pulumi.StringArray{
						pulumi.String("Development"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.Association("example", new()
    {
        Name = "AmazonCloudWatch-ManageAgent",
        Targets = new[]
        {
            new Aws.Ssm.Inputs.AssociationTargetArgs
            {
                Key = "tag:Environment",
                Values = new[]
                {
                    "Development",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Association;
import com.pulumi.aws.ssm.AssociationArgs;
import com.pulumi.aws.ssm.inputs.AssociationTargetArgs;
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 example = new Association("example", AssociationArgs.builder()
            .name("AmazonCloudWatch-ManageAgent")
            .targets(AssociationTargetArgs.builder()
                .key("tag:Environment")
                .values("Development")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:Association
    properties:
      name: AmazonCloudWatch-ManageAgent
      targets:
        - key: tag:Environment
          values:
            - Development
Copy

Create an association with a specific schedule

This example shows how to schedule an association in various ways.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssm.Association("example", {
    name: exampleAwsSsmDocument.name,
    scheduleExpression: "cron(0 2 ? * SUN *)",
    targets: [{
        key: "InstanceIds",
        values: [exampleAwsInstance.id],
    }],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssm.Association("example",
    name=example_aws_ssm_document["name"],
    schedule_expression="cron(0 2 ? * SUN *)",
    targets=[{
        "key": "InstanceIds",
        "values": [example_aws_instance["id"]],
    }])
Copy
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 {
		_, err := ssm.NewAssociation(ctx, "example", &ssm.AssociationArgs{
			Name:               pulumi.Any(exampleAwsSsmDocument.Name),
			ScheduleExpression: pulumi.String("cron(0 2 ? * SUN *)"),
			Targets: ssm.AssociationTargetArray{
				&ssm.AssociationTargetArgs{
					Key: pulumi.String("InstanceIds"),
					Values: pulumi.StringArray{
						exampleAwsInstance.Id,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ssm.Association("example", new()
    {
        Name = exampleAwsSsmDocument.Name,
        ScheduleExpression = "cron(0 2 ? * SUN *)",
        Targets = new[]
        {
            new Aws.Ssm.Inputs.AssociationTargetArgs
            {
                Key = "InstanceIds",
                Values = new[]
                {
                    exampleAwsInstance.Id,
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Association;
import com.pulumi.aws.ssm.AssociationArgs;
import com.pulumi.aws.ssm.inputs.AssociationTargetArgs;
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 example = new Association("example", AssociationArgs.builder()
            .name(exampleAwsSsmDocument.name())
            .scheduleExpression("cron(0 2 ? * SUN *)")
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values(exampleAwsInstance.id())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ssm:Association
    properties:
      name: ${exampleAwsSsmDocument.name}
      scheduleExpression: cron(0 2 ? * SUN *)
      targets:
        - key: InstanceIds
          values:
            - ${exampleAwsInstance.id}
Copy

Create Association Resource

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

Constructor syntax

new Association(name: string, args?: AssociationArgs, opts?: CustomResourceOptions);
@overload
def Association(resource_name: str,
                args: Optional[AssociationArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Association(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                apply_only_at_cron_interval: Optional[bool] = None,
                association_name: Optional[str] = None,
                automation_target_parameter_name: Optional[str] = None,
                compliance_severity: Optional[str] = None,
                document_version: Optional[str] = None,
                instance_id: Optional[str] = None,
                max_concurrency: Optional[str] = None,
                max_errors: Optional[str] = None,
                name: Optional[str] = None,
                output_location: Optional[AssociationOutputLocationArgs] = None,
                parameters: Optional[Mapping[str, str]] = None,
                schedule_expression: Optional[str] = None,
                sync_compliance: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                targets: Optional[Sequence[AssociationTargetArgs]] = None,
                wait_for_success_timeout_seconds: Optional[int] = None)
func NewAssociation(ctx *Context, name string, args *AssociationArgs, opts ...ResourceOption) (*Association, error)
public Association(string name, AssociationArgs? args = null, CustomResourceOptions? opts = null)
public Association(String name, AssociationArgs args)
public Association(String name, AssociationArgs args, CustomResourceOptions options)

type: aws:ssm:Association
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var awsAssociationResource = new Aws.Ssm.Association("awsAssociationResource", new()
{
    ApplyOnlyAtCronInterval = false,
    AssociationName = "string",
    AutomationTargetParameterName = "string",
    ComplianceSeverity = "string",
    DocumentVersion = "string",
    MaxConcurrency = "string",
    MaxErrors = "string",
    Name = "string",
    OutputLocation = new Aws.Ssm.Inputs.AssociationOutputLocationArgs
    {
        S3BucketName = "string",
        S3KeyPrefix = "string",
        S3Region = "string",
    },
    Parameters = 
    {
        { "string", "string" },
    },
    ScheduleExpression = "string",
    SyncCompliance = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Targets = new[]
    {
        new Aws.Ssm.Inputs.AssociationTargetArgs
        {
            Key = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
    WaitForSuccessTimeoutSeconds = 0,
});
Copy
example, err := ssm.NewAssociation(ctx, "awsAssociationResource", &ssm.AssociationArgs{
	ApplyOnlyAtCronInterval:       pulumi.Bool(false),
	AssociationName:               pulumi.String("string"),
	AutomationTargetParameterName: pulumi.String("string"),
	ComplianceSeverity:            pulumi.String("string"),
	DocumentVersion:               pulumi.String("string"),
	MaxConcurrency:                pulumi.String("string"),
	MaxErrors:                     pulumi.String("string"),
	Name:                          pulumi.String("string"),
	OutputLocation: &ssm.AssociationOutputLocationArgs{
		S3BucketName: pulumi.String("string"),
		S3KeyPrefix:  pulumi.String("string"),
		S3Region:     pulumi.String("string"),
	},
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ScheduleExpression: pulumi.String("string"),
	SyncCompliance:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Targets: ssm.AssociationTargetArray{
		&ssm.AssociationTargetArgs{
			Key: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	WaitForSuccessTimeoutSeconds: pulumi.Int(0),
})
Copy
var awsAssociationResource = new Association("awsAssociationResource", AssociationArgs.builder()
    .applyOnlyAtCronInterval(false)
    .associationName("string")
    .automationTargetParameterName("string")
    .complianceSeverity("string")
    .documentVersion("string")
    .maxConcurrency("string")
    .maxErrors("string")
    .name("string")
    .outputLocation(AssociationOutputLocationArgs.builder()
        .s3BucketName("string")
        .s3KeyPrefix("string")
        .s3Region("string")
        .build())
    .parameters(Map.of("string", "string"))
    .scheduleExpression("string")
    .syncCompliance("string")
    .tags(Map.of("string", "string"))
    .targets(AssociationTargetArgs.builder()
        .key("string")
        .values("string")
        .build())
    .waitForSuccessTimeoutSeconds(0)
    .build());
Copy
aws_association_resource = aws.ssm.Association("awsAssociationResource",
    apply_only_at_cron_interval=False,
    association_name="string",
    automation_target_parameter_name="string",
    compliance_severity="string",
    document_version="string",
    max_concurrency="string",
    max_errors="string",
    name="string",
    output_location={
        "s3_bucket_name": "string",
        "s3_key_prefix": "string",
        "s3_region": "string",
    },
    parameters={
        "string": "string",
    },
    schedule_expression="string",
    sync_compliance="string",
    tags={
        "string": "string",
    },
    targets=[{
        "key": "string",
        "values": ["string"],
    }],
    wait_for_success_timeout_seconds=0)
Copy
const awsAssociationResource = new aws.ssm.Association("awsAssociationResource", {
    applyOnlyAtCronInterval: false,
    associationName: "string",
    automationTargetParameterName: "string",
    complianceSeverity: "string",
    documentVersion: "string",
    maxConcurrency: "string",
    maxErrors: "string",
    name: "string",
    outputLocation: {
        s3BucketName: "string",
        s3KeyPrefix: "string",
        s3Region: "string",
    },
    parameters: {
        string: "string",
    },
    scheduleExpression: "string",
    syncCompliance: "string",
    tags: {
        string: "string",
    },
    targets: [{
        key: "string",
        values: ["string"],
    }],
    waitForSuccessTimeoutSeconds: 0,
});
Copy
type: aws:ssm:Association
properties:
    applyOnlyAtCronInterval: false
    associationName: string
    automationTargetParameterName: string
    complianceSeverity: string
    documentVersion: string
    maxConcurrency: string
    maxErrors: string
    name: string
    outputLocation:
        s3BucketName: string
        s3KeyPrefix: string
        s3Region: string
    parameters:
        string: string
    scheduleExpression: string
    syncCompliance: string
    tags:
        string: string
    targets:
        - key: string
          values:
            - string
    waitForSuccessTimeoutSeconds: 0
Copy

Association Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Association resource accepts the following input properties:

ApplyOnlyAtCronInterval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
AssociationName string
The descriptive name for the association.
AutomationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
ComplianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
DocumentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
InstanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

MaxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
MaxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
Name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
OutputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
Parameters Dictionary<string, string>
A block of arbitrary string parameters to pass to the SSM document.
ScheduleExpression string
A cron or rate expression that specifies when the association runs.
SyncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
Tags Dictionary<string, string>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Targets List<AssociationTarget>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
WaitForSuccessTimeoutSeconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

ApplyOnlyAtCronInterval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
AssociationName string
The descriptive name for the association.
AutomationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
ComplianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
DocumentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
InstanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

MaxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
MaxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
Name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
OutputLocation AssociationOutputLocationArgs
An output location block. Output Location is documented below.
Parameters map[string]string
A block of arbitrary string parameters to pass to the SSM document.
ScheduleExpression string
A cron or rate expression that specifies when the association runs.
SyncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
Tags map[string]string
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Targets []AssociationTargetArgs
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
WaitForSuccessTimeoutSeconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval Boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
associationName String
The descriptive name for the association.
automationTargetParameterName String
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity String
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion String
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. String
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency String
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. String
The name of the SSM document to apply.
outputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
parameters Map<String,String>
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression String
A cron or rate expression that specifies when the association runs.
syncCompliance String
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Map<String,String>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
targets List<AssociationTarget>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds Integer

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
associationName string
The descriptive name for the association.
automationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
outputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
parameters {[key: string]: string}
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression string
A cron or rate expression that specifies when the association runs.
syncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags {[key: string]: string}
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
targets AssociationTarget[]
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds number

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

apply_only_at_cron_interval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
association_name str
The descriptive name for the association.
automation_target_parameter_name str
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
compliance_severity str
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
document_version str
The document version you want to associate with the target(s). Can be a specific version or the default version.
instance_id Changes to this property will trigger replacement. str
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

max_concurrency str
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
max_errors str
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. str
The name of the SSM document to apply.
output_location AssociationOutputLocationArgs
An output location block. Output Location is documented below.
parameters Mapping[str, str]
A block of arbitrary string parameters to pass to the SSM document.
schedule_expression str
A cron or rate expression that specifies when the association runs.
sync_compliance str
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Mapping[str, str]
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
targets Sequence[AssociationTargetArgs]
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
wait_for_success_timeout_seconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval Boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
associationName String
The descriptive name for the association.
automationTargetParameterName String
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity String
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion String
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. String
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency String
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. String
The name of the SSM document to apply.
outputLocation Property Map
An output location block. Output Location is documented below.
parameters Map<String>
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression String
A cron or rate expression that specifies when the association runs.
syncCompliance String
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Map<String>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
targets List<Property Map>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds Number

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

Outputs

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

Arn string
The ARN of the SSM association
AssociationId string
The ID of the SSM association.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the SSM association
AssociationId string
The ID of the SSM association.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the SSM association
associationId String
The ID of the SSM association.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the SSM association
associationId string
The ID of the SSM association.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the SSM association
association_id str
The ID of the SSM association.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the SSM association
associationId String
The ID of the SSM association.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Association Resource

Get an existing Association 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?: AssociationState, opts?: CustomResourceOptions): Association
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_only_at_cron_interval: Optional[bool] = None,
        arn: Optional[str] = None,
        association_id: Optional[str] = None,
        association_name: Optional[str] = None,
        automation_target_parameter_name: Optional[str] = None,
        compliance_severity: Optional[str] = None,
        document_version: Optional[str] = None,
        instance_id: Optional[str] = None,
        max_concurrency: Optional[str] = None,
        max_errors: Optional[str] = None,
        name: Optional[str] = None,
        output_location: Optional[AssociationOutputLocationArgs] = None,
        parameters: Optional[Mapping[str, str]] = None,
        schedule_expression: Optional[str] = None,
        sync_compliance: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        targets: Optional[Sequence[AssociationTargetArgs]] = None,
        wait_for_success_timeout_seconds: Optional[int] = None) -> Association
func GetAssociation(ctx *Context, name string, id IDInput, state *AssociationState, opts ...ResourceOption) (*Association, error)
public static Association Get(string name, Input<string> id, AssociationState? state, CustomResourceOptions? opts = null)
public static Association get(String name, Output<String> id, AssociationState state, CustomResourceOptions options)
resources:  _:    type: aws:ssm:Association    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApplyOnlyAtCronInterval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
Arn string
The ARN of the SSM association
AssociationId string
The ID of the SSM association.
AssociationName string
The descriptive name for the association.
AutomationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
ComplianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
DocumentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
InstanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

MaxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
MaxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
Name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
OutputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
Parameters Dictionary<string, string>
A block of arbitrary string parameters to pass to the SSM document.
ScheduleExpression string
A cron or rate expression that specifies when the association runs.
SyncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
Tags Dictionary<string, string>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Targets List<AssociationTarget>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
WaitForSuccessTimeoutSeconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

ApplyOnlyAtCronInterval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
Arn string
The ARN of the SSM association
AssociationId string
The ID of the SSM association.
AssociationName string
The descriptive name for the association.
AutomationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
ComplianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
DocumentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
InstanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

MaxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
MaxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
Name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
OutputLocation AssociationOutputLocationArgs
An output location block. Output Location is documented below.
Parameters map[string]string
A block of arbitrary string parameters to pass to the SSM document.
ScheduleExpression string
A cron or rate expression that specifies when the association runs.
SyncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
Tags map[string]string
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Targets []AssociationTargetArgs
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
WaitForSuccessTimeoutSeconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval Boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
arn String
The ARN of the SSM association
associationId String
The ID of the SSM association.
associationName String
The descriptive name for the association.
automationTargetParameterName String
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity String
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion String
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. String
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency String
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. String
The name of the SSM document to apply.
outputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
parameters Map<String,String>
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression String
A cron or rate expression that specifies when the association runs.
syncCompliance String
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Map<String,String>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targets List<AssociationTarget>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds Integer

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
arn string
The ARN of the SSM association
associationId string
The ID of the SSM association.
associationName string
The descriptive name for the association.
automationTargetParameterName string
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity string
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion string
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. string
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency string
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors string
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. string
The name of the SSM document to apply.
outputLocation AssociationOutputLocation
An output location block. Output Location is documented below.
parameters {[key: string]: string}
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression string
A cron or rate expression that specifies when the association runs.
syncCompliance string
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags {[key: string]: string}
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targets AssociationTarget[]
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds number

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

apply_only_at_cron_interval bool
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
arn str
The ARN of the SSM association
association_id str
The ID of the SSM association.
association_name str
The descriptive name for the association.
automation_target_parameter_name str
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
compliance_severity str
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
document_version str
The document version you want to associate with the target(s). Can be a specific version or the default version.
instance_id Changes to this property will trigger replacement. str
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

max_concurrency str
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
max_errors str
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. str
The name of the SSM document to apply.
output_location AssociationOutputLocationArgs
An output location block. Output Location is documented below.
parameters Mapping[str, str]
A block of arbitrary string parameters to pass to the SSM document.
schedule_expression str
A cron or rate expression that specifies when the association runs.
sync_compliance str
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Mapping[str, str]
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targets Sequence[AssociationTargetArgs]
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
wait_for_success_timeout_seconds int

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

applyOnlyAtCronInterval Boolean
By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: false.
arn String
The ARN of the SSM association
associationId String
The ID of the SSM association.
associationName String
The descriptive name for the association.
automationTargetParameterName String
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls. This should be set to the SSM document parameter that will define how your automation will branch out.
complianceSeverity String
The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL
documentVersion String
The document version you want to associate with the target(s). Can be a specific version or the default version.
instanceId Changes to this property will trigger replacement. String
The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above. Use the targets attribute instead.

Deprecated: instance_id is deprecated. Use targets instead.

maxConcurrency String
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%.
maxErrors String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned.
name Changes to this property will trigger replacement. String
The name of the SSM document to apply.
outputLocation Property Map
An output location block. Output Location is documented below.
parameters Map<String>
A block of arbitrary string parameters to pass to the SSM document.
scheduleExpression String
A cron or rate expression that specifies when the association runs.
syncCompliance String
The mode for generating association compliance. You can specify AUTO or MANUAL.
tags Map<String>
A map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targets List<Property Map>
A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
waitForSuccessTimeoutSeconds Number

The number of seconds to wait for the association status to be Success. If Success status is not reached within the given time, create opration will fail.

Output Location (output_location) is an S3 bucket where you want to store the results of this association:

Supporting Types

AssociationOutputLocation
, AssociationOutputLocationArgs

S3BucketName This property is required. string
The S3 bucket name.
S3KeyPrefix string
The S3 bucket prefix. Results stored in the root if not configured.
S3Region string

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

S3BucketName This property is required. string
The S3 bucket name.
S3KeyPrefix string
The S3 bucket prefix. Results stored in the root if not configured.
S3Region string

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

s3BucketName This property is required. String
The S3 bucket name.
s3KeyPrefix String
The S3 bucket prefix. Results stored in the root if not configured.
s3Region String

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

s3BucketName This property is required. string
The S3 bucket name.
s3KeyPrefix string
The S3 bucket prefix. Results stored in the root if not configured.
s3Region string

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

s3_bucket_name This property is required. str
The S3 bucket name.
s3_key_prefix str
The S3 bucket prefix. Results stored in the root if not configured.
s3_region str

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

s3BucketName This property is required. String
The S3 bucket name.
s3KeyPrefix String
The S3 bucket prefix. Results stored in the root if not configured.
s3Region String

The S3 bucket region.

Targets specify what instance IDs or tags to apply the document to and has these keys:

AssociationTarget
, AssociationTargetArgs

Key This property is required. string
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
Values This property is required. List<string>
A list of instance IDs or tag values. AWS currently limits this list size to one value.
Key This property is required. string
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
Values This property is required. []string
A list of instance IDs or tag values. AWS currently limits this list size to one value.
key This property is required. String
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values This property is required. List<String>
A list of instance IDs or tag values. AWS currently limits this list size to one value.
key This property is required. string
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values This property is required. string[]
A list of instance IDs or tag values. AWS currently limits this list size to one value.
key This property is required. str
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values This property is required. Sequence[str]
A list of instance IDs or tag values. AWS currently limits this list size to one value.
key This property is required. String
Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values This property is required. List<String>
A list of instance IDs or tag values. AWS currently limits this list size to one value.

Import

Using pulumi import, import SSM associations using the association_id. For example:

$ pulumi import aws:ssm/association:Association test-association 10abcdef-0abc-1234-5678-90abcdef123456
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws