You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::CreateAssociationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateAssociationRequest data as a hash:

{
  name: "DocumentARN", # required
  document_version: "DocumentVersion",
  instance_id: "InstanceId",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  schedule_expression: "ScheduleExpression",
  output_location: {
    s3_location: {
      output_s3_region: "S3Region",
      output_s3_bucket_name: "S3BucketName",
      output_s3_key_prefix: "S3KeyPrefix",
    },
  },
  association_name: "AssociationName",
  automation_target_parameter_name: "AutomationTargetParameterName",
  max_errors: "MaxErrors",
  max_concurrency: "MaxConcurrency",
  compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
}

Instance Attribute Summary collapse

Instance Attribute Details

#association_nameString

Specify a descriptive name for the association.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#automation_target_parameter_nameString

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

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#compliance_severityString

The severity level to assign to the association.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#document_versionString

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

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#instance_idString

The instance ID.

InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#max_concurrencyString

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.

If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#max_errorsString

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 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors 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 MaxConcurrency to 1 so that executions proceed one at a time.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#nameString

The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

arn:partition:ssm:region:account-id:document/document-name

For example:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

An Amazon S3 bucket where you want to store the output details of the request.



2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The parameters for the runtime configuration of the document.

Returns:

  • (Hash<String,Array<String>>)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)


2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets (either instances or tags) for the association. You must specify a value for Targets if you don't specify a value for InstanceId.

Returns:



2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2560

class CreateAssociationRequest < Struct.new(
  :name,
  :document_version,
  :instance_id,
  :parameters,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :automation_target_parameter_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity)
  include Aws::Structure
end