create_association ¶

def create_association(
    self,
    name: "capo_ssm.types.document_arn.DocumentARN",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    document_version: Optional[
        "capo_ssm.types.document_version.DocumentVersion"
    ] = None,
    instance_id: Optional["capo_ssm.types.instance_id.InstanceId"] = None,
    parameters: Optional["capo_ssm.types.parameters.Parameters"] = None,
    targets: Optional["capo_ssm.types.targets.Targets"] = None,
    schedule_expression: Optional[
        "capo_ssm.types.schedule_expression.ScheduleExpression"
    ] = None,
    output_location: Optional[
        "capo_ssm.types.instance_association_output_location.InstanceAssociationOutputLocation"
    ] = None,
    association_name: Optional[
        "capo_ssm.types.association_name.AssociationName"
    ] = None,
    automation_target_parameter_name: Optional[
        "capo_ssm.types.automation_target_parameter_name.AutomationTargetParameterName"
    ] = None,
    max_errors: Optional["capo_ssm.types.max_errors.MaxErrors"] = None,
    max_concurrency: Optional[
        "capo_ssm.types.max_concurrency.MaxConcurrency"
    ] = None,
    compliance_severity: Optional[
        "capo_ssm.types.association_compliance_severity.AssociationComplianceSeverity"
    ] = None,
    sync_compliance: Optional[
        "capo_ssm.types.association_sync_compliance.AssociationSyncCompliance"
    ] = None,
    apply_only_at_cron_interval: Optional[
        "capo_ssm.types.apply_only_at_cron_interval.ApplyOnlyAtCronInterval"
    ] = None,
    calendar_names: Optional[
        "capo_ssm.types.calendar_name_or_arn_list.CalendarNameOrARNList"
    ] = None,
    target_locations: Optional[
        "capo_ssm.types.target_locations.TargetLocations"
    ] = None,
    schedule_offset: Optional[
        "capo_ssm.types.schedule_offset.ScheduleOffset"
    ] = None,
    duration: Optional["capo_ssm.types.duration.Duration"] = None,
    target_maps: Optional["capo_ssm.types.target_maps.TargetMaps"] = None,
    tags: Optional["capo_ssm.types.tag_list.TagList"] = None,
    alarm_configuration: Optional[
        "capo_ssm.types.alarm_configuration.AlarmConfiguration"
    ] = None,
    association_dispatch_assume_role: Optional[
        "capo_ssm.types.association_dispatch_assume_role_arn.AssociationDispatchAssumeRoleArn"
    ] = None,
) -> "capo_ssm.types.create_association_result.CreateAssociationResult":
    """<p>A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. </p>

    Args:
        name: <p>The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.</p> <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services account.</p> <p>For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:</p> <p> <code>arn:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i> </code> </p> <p>For example:</p> <p> <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code> </p> <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or <code>My-Document</code>.</p>
        document_version: <p>The document version you want to associate with the targets. Can be a specific version or the default version.</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>
        instance_id: <p>The managed node ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify a managed node ID for an association, use the <code>Targets</code> parameter. Requests that include the parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>
        parameters: <p>The parameters for the runtime configuration of the document.</p>
        targets: <p>The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. 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>. For more information about choosing targets for an association, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html">Understanding targets and rate controls in State Manager associations</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
        schedule_expression: <p>A cron expression when the association will be applied to the targets.</p>
        output_location: <p>An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.</p>
        association_name: <p>Specify a descriptive name for the association.</p>
        automation_target_parameter_name: <p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.</p>
        max_errors: <p>The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set <code>MaxError</code> to 10%, then the system stops sending the request when the sixth error is received.</p> <p>Executions that are already running an association when <code>MaxErrors</code> is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1 so that executions proceed one at a time.</p>
        max_concurrency: <p>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%. The default value is 100%, which means all targets run the association at the same time.</p> <p>If a new managed node starts and attempts to run an association while Systems Manager is running <code>MaxConcurrency</code> associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for <code>MaxConcurrency</code>.</p>
        compliance_severity: <p>The severity level to assign to the association.</p>
        sync_compliance: <p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>
        apply_only_at_cron_interval: <p>By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify <code>true</code> for <code>ApplyOnlyAtCronInterval</code>if you want the association to run only according to the schedule you specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling">Understanding when associations are applied to resources</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates">>About target updates with Automation runbooks</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>This parameter isn't supported for rate expressions.</p>
        calendar_names: <p>The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
        target_locations: <p>A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.</p> <note> <p>The <code>TargetLocationAlarmConfiguration</code> parameter is not supported by State Manager.</p> </note>
        schedule_offset: <p>Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This option tells the system not to run an association immediately after you create it. </p> </note>
        duration: <p>The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot. </p> <p>The <code>Duration</code> parameter applies only when both these conditions are true:</p> <ul> <li> <p>The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution. </p> </li> <li> <p>The command specifies the <code> <a href="https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval">ApplyOnlyAtCronInterval</a> </code> parameter, which means that the association doesn't run immediately after it is created, but only according to the specified schedule.</p> </li> </ul>
        target_maps: <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.</p>
        tags: <p>Adds or overwrites one or more tags for a State Manager association. <i>Tags</i> are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. </p>
        association_dispatch_assume_role: <p>A role used by association to take actions on your behalf. State Manager will assume this role and call required APIs when dispatching configurations to nodes. If not specified, <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html"> service-linked role for Systems Manager</a> will be used by default. </p> <note> <p>It is recommended that you define a custom IAM role so that you have full control of the permissions that State Manager has when taking actions on your behalf.</p> <p>Service-linked role support in State Manager is being phased out. Associations relying on service-linked role may require updates in the future to continue functioning properly.</p> </note>

    Raises:
        capo_ssm.errors.association_already_exists.AssociationAlreadyExists: <p>The specified association already exists.</p>
        capo_ssm.errors.association_limit_exceeded.AssociationLimitExceeded: <p>You can have at most 2,000 active associations.</p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_document.InvalidDocument: <p>The specified SSM document doesn't exist.</p>
        capo_ssm.errors.invalid_document_version.InvalidDocumentVersion: <p>The document version isn't valid or doesn't exist.</p>
        capo_ssm.errors.invalid_instance_id.InvalidInstanceId: <p>The following problems can cause this exception:</p> <ul> <li> <p>You don't have permission to access the managed node.</p> </li> <li> <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.</p> </li> <li> <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p> </li> <li> <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>, <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are: <code>Shutting-down</code> and <code>Terminated</code>.</p> </li> </ul>
        capo_ssm.errors.invalid_output_location.InvalidOutputLocation: <p>The output location isn't valid or doesn't exist.</p>
        capo_ssm.errors.invalid_parameters.InvalidParameters: <p>You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.</p>
        capo_ssm.errors.invalid_schedule.InvalidSchedule: <p>The schedule is invalid. Verify your cron or rate expression and try again.</p>
        capo_ssm.errors.invalid_tag.InvalidTag: <p>The specified tag key or value isn't valid.</p>
        capo_ssm.errors.invalid_target.InvalidTarget: <p>The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.</p>
        capo_ssm.errors.invalid_target_maps.InvalidTargetMaps: <p>TargetMap parameter isn't valid.</p>
        capo_ssm.errors.unsupported_platform_type.UnsupportedPlatformType: <p>The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.create_association_request.CreateAssociationRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.create_association_result.CreateAssociationResult"
    ]:
        import capo_ssm._operations.amazon_ssm.create_association

        output, http_response = (
            capo_ssm._operations.amazon_ssm.create_association.create_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ssm.types.create_association_request.CreateAssociationRequest",
    ) -> dict[str, Any]:
        import capo_ssm.types.create_association_request

        return capo_ssm.types.create_association_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_ssm.types.create_association_result.CreateAssociationResult",
    ) -> dict[str, Any]:
        import capo_ssm.types.create_association_result

        return capo_ssm.types.create_association_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateAssociation",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_ssm.types.create_association_request.CreateAssociationRequest = {
        "name": name
    }
    if document_version is not None:
        input_["document_version"] = document_version
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if parameters is not None:
        input_["parameters"] = parameters
    if targets is not None:
        input_["targets"] = targets
    if schedule_expression is not None:
        input_["schedule_expression"] = schedule_expression
    if output_location is not None:
        input_["output_location"] = output_location
    if association_name is not None:
        input_["association_name"] = association_name
    if automation_target_parameter_name is not None:
        input_["automation_target_parameter_name"] = (
            automation_target_parameter_name
        )
    if max_errors is not None:
        input_["max_errors"] = max_errors
    if max_concurrency is not None:
        input_["max_concurrency"] = max_concurrency
    if compliance_severity is not None:
        input_["compliance_severity"] = compliance_severity
    if sync_compliance is not None:
        input_["sync_compliance"] = sync_compliance
    if apply_only_at_cron_interval is not None:
        input_["apply_only_at_cron_interval"] = apply_only_at_cron_interval
    if calendar_names is not None:
        input_["calendar_names"] = calendar_names
    if target_locations is not None:
        input_["target_locations"] = target_locations
    if schedule_offset is not None:
        input_["schedule_offset"] = schedule_offset
    if duration is not None:
        input_["duration"] = duration
    if target_maps is not None:
        input_["target_maps"] = target_maps
    if tags is not None:
        input_["tags"] = tags
    if alarm_configuration is not None:
        input_["alarm_configuration"] = alarm_configuration
    if association_dispatch_assume_role is not None:
        input_["association_dispatch_assume_role"] = (
            association_dispatch_assume_role
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output