Association

Associates an SSM Document to an instance or EC2 tag.

Create a Association Resource

new Association(name: string, args?: AssociationArgs, opts?: CustomResourceOptions);

def Association(resource_name, opts=None, association_name=None, automation_target_parameter_name=None, compliance_severity=None, document_version=None, instance_id=None, max_concurrency=None, max_errors=None, name=None, output_location=None, parameters=None, schedule_expression=None, targets=None, __props__=None);

func NewAssociation(ctx *Context, name string, args *AssociationArgs, opts ...ResourceOption) (*Association, error)

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

name 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 str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name 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 string: The unique name of the resource.
args AssociationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Association Resource Properties

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

Inputs

The Association resource accepts the following input properties:

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
Name string: The name of the SSM document to apply.
OutputLocation AssociationOutputLocationArgs: 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 expression when the association will be applied to the target(s).
Targets List<AssociationTargetArgs>: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
Name 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 expression when the association will be applied to the target(s).
Targets []AssociationTarget: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
name 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 expression when the association will be applied to the target(s).
targets AssociationTarget[]: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 str: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
name str: The name of the SSM document to apply.
output_location Dict[AssociationOutputLocation]: An output location block. Output Location is documented below.
parameters Dict[str, str]: A block of arbitrary string parameters to pass to the SSM document.
schedule_expression str: A cron expression when the association will be applied to the target(s).
targets List[AssociationTarget]: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

Outputs

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

AssociationId string: The ID of the SSM association.
Id string: The provider-assigned unique ID for this managed resource.

AssociationId string: The ID of the SSM association.
Id string: The provider-assigned unique ID for this managed resource.

associationId string: The ID of the SSM association.
id string: The provider-assigned unique ID for this managed resource.

association_id str: The ID of the SSM association.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, association_id=None, association_name=None, automation_target_parameter_name=None, compliance_severity=None, document_version=None, instance_id=None, max_concurrency=None, max_errors=None, name=None, output_location=None, parameters=None, schedule_expression=None, targets=None, __props__=None);

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)

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.

The following state arguments are supported:

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
Name string: The name of the SSM document to apply.
OutputLocation AssociationOutputLocationArgs: 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 expression when the association will be applied to the target(s).
Targets List<AssociationTargetArgs>: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
Name 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 expression when the association will be applied to the target(s).
Targets []AssociationTarget: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 string: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
name 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 expression when the association will be applied to the target(s).
targets AssociationTarget[]: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

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.
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 str: The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
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%.
name str: The name of the SSM document to apply.
output_location Dict[AssociationOutputLocation]: An output location block. Output Location is documented below.
parameters Dict[str, str]: A block of arbitrary string parameters to pass to the SSM document.
schedule_expression str: A cron expression when the association will be applied to the target(s).
targets List[AssociationTarget]: A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

Supporting Types

AssociationOutputLocation

See the input and output API doc for this type.

S3BucketName string: The S3 bucket name.
S3KeyPrefix string: The S3 bucket prefix. Results stored in the root if not configured.

S3BucketName string: The S3 bucket name.
S3KeyPrefix string: The S3 bucket prefix. Results stored in the root if not configured.

s3BucketName string: The S3 bucket name.
s3KeyPrefix string: The S3 bucket prefix. Results stored in the root if not configured.

s3_bucket_name str: The S3 bucket name.
s3_key_prefix str: The S3 bucket prefix. Results stored in the root if not configured.

AssociationTarget

See the input and output API doc for this type.

Key string: Either InstanceIds or tag:Tag Name to specify an EC2 tag.
Values List<string>: A list of instance IDs or tag values. AWS currently limits this list size to one value.

Key string: Either InstanceIds or tag:Tag Name to specify an EC2 tag.
Values []string: A list of instance IDs or tag values. AWS currently limits this list size to one value.

key string: Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values string[]: A list of instance IDs or tag values. AWS currently limits this list size to one value.

key str: Either InstanceIds or tag:Tag Name to specify an EC2 tag.
values List[str]: A list of instance IDs or tag values. AWS currently limits this list size to one value.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud