CfnAssociationProps

class aws_cdk.aws_ssm.CfnAssociationProps(*, apply_only_at_cron_interval=None, association_name=None, automation_target_parameter_name=None, calendar_names=None, compliance_severity=None, document_version=None, instance_id=None, max_concurrency=None, max_errors=None, name, output_location=None, parameters=None, schedule_expression=None, sync_compliance=None, targets=None, wait_for_success_timeout_seconds=None)

Bases: object

Properties for defining a AWS::SSM::Association.

Parameters
  • apply_only_at_cron_interval (Union[bool, IResolvable, None]) – AWS::SSM::Association.ApplyOnlyAtCronInterval.

  • association_name (Optional[str]) – AWS::SSM::Association.AssociationName.

  • automation_target_parameter_name (Optional[str]) – AWS::SSM::Association.AutomationTargetParameterName.

  • calendar_names (Optional[Sequence[str]]) – AWS::SSM::Association.CalendarNames.

  • compliance_severity (Optional[str]) – AWS::SSM::Association.ComplianceSeverity.

  • document_version (Optional[str]) – AWS::SSM::Association.DocumentVersion.

  • instance_id (Optional[str]) – AWS::SSM::Association.InstanceId.

  • max_concurrency (Optional[str]) – AWS::SSM::Association.MaxConcurrency.

  • max_errors (Optional[str]) – AWS::SSM::Association.MaxErrors.

  • name (str) – AWS::SSM::Association.Name.

  • output_location (Union[IResolvable, InstanceAssociationOutputLocationProperty, None]) – AWS::SSM::Association.OutputLocation.

  • parameters (Union[IResolvable, Mapping[str, Any], None]) – AWS::SSM::Association.Parameters.

  • schedule_expression (Optional[str]) – AWS::SSM::Association.ScheduleExpression.

  • sync_compliance (Optional[str]) – AWS::SSM::Association.SyncCompliance.

  • targets (Union[IResolvable, Sequence[Union[IResolvable, TargetProperty]], None]) – AWS::SSM::Association.Targets.

  • wait_for_success_timeout_seconds (Union[int, float, None]) – AWS::SSM::Association.WaitForSuccessTimeoutSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

# parameters is of type object

cfn_association_props = ssm.CfnAssociationProps(
    name="name",

    # the properties below are optional
    apply_only_at_cron_interval=False,
    association_name="associationName",
    automation_target_parameter_name="automationTargetParameterName",
    calendar_names=["calendarNames"],
    compliance_severity="complianceSeverity",
    document_version="documentVersion",
    instance_id="instanceId",
    max_concurrency="maxConcurrency",
    max_errors="maxErrors",
    output_location=ssm.CfnAssociation.InstanceAssociationOutputLocationProperty(
        s3_location=ssm.CfnAssociation.S3OutputLocationProperty(
            output_s3_bucket_name="outputS3BucketName",
            output_s3_key_prefix="outputS3KeyPrefix",
            output_s3_region="outputS3Region"
        )
    ),
    parameters={
        "parameters_key": parameters
    },
    schedule_expression="scheduleExpression",
    sync_compliance="syncCompliance",
    targets=[ssm.CfnAssociation.TargetProperty(
        key="key",
        values=["values"]
    )],
    wait_for_success_timeout_seconds=123
)

Attributes

apply_only_at_cron_interval

AWS::SSM::Association.ApplyOnlyAtCronInterval.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval

Return type

Union[bool, IResolvable, None]

association_name

AWS::SSM::Association.AssociationName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname

Return type

Optional[str]

automation_target_parameter_name

AWS::SSM::Association.AutomationTargetParameterName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername

Return type

Optional[str]

calendar_names

AWS::SSM::Association.CalendarNames.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames

Return type

Optional[List[str]]

compliance_severity

AWS::SSM::Association.ComplianceSeverity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity

Return type

Optional[str]

document_version

AWS::SSM::Association.DocumentVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion

Return type

Optional[str]

instance_id

AWS::SSM::Association.InstanceId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid

Return type

Optional[str]

max_concurrency

AWS::SSM::Association.MaxConcurrency.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency

Return type

Optional[str]

max_errors

AWS::SSM::Association.MaxErrors.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors

Return type

Optional[str]

name

AWS::SSM::Association.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name

Return type

str

output_location

AWS::SSM::Association.OutputLocation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation

Return type

Union[IResolvable, InstanceAssociationOutputLocationProperty, None]

parameters

AWS::SSM::Association.Parameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters

Return type

Union[IResolvable, Mapping[str, Any], None]

schedule_expression

AWS::SSM::Association.ScheduleExpression.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression

Return type

Optional[str]

sync_compliance

AWS::SSM::Association.SyncCompliance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance

Return type

Optional[str]

targets

AWS::SSM::Association.Targets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets

Return type

Union[IResolvable, List[Union[IResolvable, TargetProperty]], None]

wait_for_success_timeout_seconds

AWS::SSM::Association.WaitForSuccessTimeoutSeconds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds

Return type

Union[int, float, None]