Class Association

Associates an SSM Document to an instance or EC2 tag.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Ssm.Association("example", new Aws.Ssm.AssociationArgs
    {
        Targets = 
        {
            new Aws.Ssm.Inputs.AssociationTargetArgs
            {
                Key = "InstanceIds",
                Values = 
                {
                    aws_instance.Example.Id,
                },
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Association

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ssm

Assembly: Pulumi.Aws.dll

Syntax

public class Association : CustomResource

Constructors

Association(String, AssociationArgs, CustomResourceOptions)

Create a Association resource with the given unique name, arguments, and options.

Declaration

public Association(string name, AssociationArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AssociationArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AssociationId

The ID of the SSM association.

Declaration

public Output<string> AssociationId { get; }

Property Value

Type	Description
Output<System.String>

AssociationName

The descriptive name for the association.

Declaration

public Output<string> AssociationName { get; }

Property Value

Type	Description
Output<System.String>

AutomationTargetParameterName

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Declaration

public Output<string> AutomationTargetParameterName { get; }

Property Value

Type	Description
Output<System.String>

ComplianceSeverity

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

Declaration

public Output<string> ComplianceSeverity { get; }

Property Value

Type	Description
Output<System.String>

DocumentVersion

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

Declaration

public Output<string> DocumentVersion { get; }

Property Value

Type	Description
Output<System.String>

InstanceId

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

Declaration

public Output<string> InstanceId { get; }

Property Value

Type	Description
Output<System.String>

MaxConcurrency

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%.

Declaration

public Output<string> MaxConcurrency { get; }

Property Value

Type	Description
Output<System.String>

MaxErrors

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%.

Declaration

public Output<string> MaxErrors { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the SSM document to apply.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

OutputLocation

An output location block. Output Location is documented below.

Declaration

public Output<AssociationOutputLocation> OutputLocation { get; }

Property Value

Type	Description
Output<AssociationOutputLocation>

Parameters

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

Declaration

public Output<ImmutableDictionary<string, object>> Parameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ScheduleExpression

A cron expression when the association will be applied to the target(s).

Declaration

public Output<string> ScheduleExpression { get; }

Property Value

Type	Description
Output<System.String>

Targets

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

Declaration

public Output<ImmutableArray<AssociationTarget>> Targets { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AssociationTarget>>

Methods

Get(String, Input<String>, AssociationState, CustomResourceOptions)

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

Declaration

public static Association Get(string name, Input<string> id, AssociationState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AssociationState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Association