pulumi-aws-kotlin/com.pulumi.aws.ssm.kotlin/Association

Association

class Association : KotlinCustomResource

Associates an SSM Document to an instance or EC2 tag.

Example Usage

Create an association for a specific instance

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()
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values(aws_instance.example().id())
                .build())
            .build());
    }
}
Content copied to clipboard

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.

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()
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values("*")
                .build())
            .build());
    }
}
Content copied to clipboard

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.

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()
            .targets(AssociationTargetArgs.builder()
                .key("tag:Environment")
                .values("Development")
                .build())
            .build());
    }
}
Content copied to clipboard

Create an association with a specific schedule

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

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()
            .scheduleExpression("cron(0 2 ? * SUN *)")
            .targets(AssociationTargetArgs.builder()
                .key("InstanceIds")
                .values(aws_instance.example().id())
                .build())
            .build());
    }
}
Content copied to clipboard

Import

SSM associations can be imported using the association_id, e.g.,

$ pulumi import aws:ssm/association:Association test-association 10abcdef-0abc-1234-5678-90abcdef123456
Content copied to clipboard

Properties

Link copied to clipboard
val applyOnlyAtCronInterval: Output<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.

Link copied to clipboard
val arn: Output<String>

The ARN of the SSM association

Link copied to clipboard
val associationId: Output<String>

The ID of the SSM association.

Link copied to clipboard
val associationName: Output<String>?

The descriptive name for the association.

Link copied to clipboard
val automationTargetParameterName: Output<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.

Link copied to clipboard
val complianceSeverity: Output<String>?

The compliance severity for the association. Can be one of the following: UNSPECIFIED, LOW, MEDIUM, HIGH or CRITICAL

Link copied to clipboard
val documentVersion: Output<String>

The document version you want to associate with the target(s). Can be a specific version or the default version.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceId: Output<String>?

The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.

Link copied to clipboard
val maxConcurrency: Output<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%.

Link copied to clipboard
val maxErrors: Output<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%.

Link copied to clipboard
val name: Output<String>

The name of the SSM document to apply.

Link copied to clipboard
val outputLocation: Output<AssociationOutputLocation>?

An output location block. Output Location is documented below.

Link copied to clipboard
val parameters: Output<Map<String, String>>

A block of arbitrary string parameters to pass to the SSM document.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val scheduleExpression: Output<String>?

A cron or rate expression that specifies when the association runs.

Link copied to clipboard
val targets: Output<List<AssociationTarget>>

A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val waitForSuccessTimeoutSeconds: Output<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: