Skip to content

Association

Source code in docs_src/capo_ssm/types/association.py
class Association(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.document_arn.DocumentARN"]
    """<p>The name of the SSM document.</p>"""
    instance_id: NotRequired["capo_ssm.types.instance_id.InstanceId"]
    """<p>The managed node ID.</p>"""
    association_id: NotRequired["capo_ssm.types.association_id.AssociationId"]
    """<p>The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.</p>"""
    association_version: NotRequired[
        "capo_ssm.types.association_version.AssociationVersion"
    ]
    """<p>The association version.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    """<p>The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p> <important> <p>State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the <code>default</code> version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to <code>default</code>.</p> </important>"""
    targets: NotRequired["capo_ssm.types.targets.Targets"]
    """<p>The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of <code>*</code>.</p>"""
    last_execution_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date on which the association was last run.</p>"""
    overview: NotRequired["capo_ssm.types.association_overview.AssociationOverview"]
    """<p>Information about the association.</p>"""
    schedule_expression: NotRequired[
        "capo_ssm.types.schedule_expression.ScheduleExpression"
    ]
    """<p>A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).</p>"""
    association_name: NotRequired["capo_ssm.types.association_name.AssociationName"]
    """<p>The association name.</p>"""
    schedule_offset: NotRequired["capo_ssm.types.schedule_offset.ScheduleOffset"]
    """<p>Number of days to wait after the scheduled day to run an association.</p>"""
    duration: NotRequired["capo_ssm.types.duration.Duration"]
    """<p>The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.</p>"""
    target_maps: NotRequired["capo_ssm.types.target_maps.TargetMaps"]
    """<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>"""

association_id instance-attribute

association_id: NotRequired[AssociationId]

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

association_name instance-attribute

association_name: NotRequired[AssociationName]

The association name.

association_version instance-attribute

association_version: NotRequired[AssociationVersion]

The association version.

document_version instance-attribute

document_version: NotRequired[DocumentVersion]

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

duration instance-attribute

duration: NotRequired[Duration]

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

The managed node ID.

last_execution_date instance-attribute

last_execution_date: NotRequired[DateTime]

The date on which the association was last run.

name instance-attribute

name: NotRequired[DocumentARN]

The name of the SSM document.

overview instance-attribute

overview: NotRequired[AssociationOverview]

Information about the association.

schedule_expression instance-attribute

schedule_expression: NotRequired[ScheduleExpression]

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

schedule_offset instance-attribute

schedule_offset: NotRequired[ScheduleOffset]

Number of days to wait after the scheduled day to run an association.

target_maps instance-attribute

target_maps: NotRequired[TargetMaps]

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

targets instance-attribute

targets: NotRequired[Targets]

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.