ssm_association.md

permalink
/ssm_association/

ssm_association

ssm_association represents the aws_ssm_association Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withApplyOnlyAtCronInterval()
• fn withAssociationName()
• fn withAutomationTargetParameterName()
• fn withComplianceSeverity()
• fn withDocumentVersion()
• fn withInstanceId()
• fn withMaxConcurrency()
• fn withMaxErrors()
• fn withName()
• fn withOutputLocation()
• fn withOutputLocationMixin()
• fn withParameters()
• fn withScheduleExpression()
• fn withSyncCompliance()
• fn withTargets()
• fn withTargetsMixin()
• fn withWaitForSuccessTimeoutSeconds()
• obj output_location
  • fn new()
• obj targets
  • fn new()

Fields

fn new

new()

aws.ssm_association.new injects a new aws_ssm_association Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.ssm_association.new('some_id')

You can get the reference to the id field of the created aws.ssm_association using the reference:

$._ref.aws_ssm_association.some_id.get('id')

This is the same as directly entering "${ aws_ssm_association.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• apply_only_at_cron_interval (bool): Set the apply_only_at_cron_interval field on the resulting resource block. When null, the apply_only_at_cron_interval field will be omitted from the resulting object.
• association_name (string): Set the association_name field on the resulting resource block. When null, the association_name field will be omitted from the resulting object.
• automation_target_parameter_name (string): Set the automation_target_parameter_name field on the resulting resource block. When null, the automation_target_parameter_name field will be omitted from the resulting object.
• compliance_severity (string): Set the compliance_severity field on the resulting resource block. When null, the compliance_severity field will be omitted from the resulting object.
• document_version (string): Set the document_version field on the resulting resource block. When null, the document_version field will be omitted from the resulting object.
• instance_id (string): Set the instance_id field on the resulting resource block. When null, the instance_id field will be omitted from the resulting object.
• max_concurrency (string): Set the max_concurrency field on the resulting resource block. When null, the max_concurrency field will be omitted from the resulting object.
• max_errors (string): Set the max_errors field on the resulting resource block. When null, the max_errors field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• parameters (obj): Set the parameters field on the resulting resource block. When null, the parameters field will be omitted from the resulting object.
• schedule_expression (string): Set the schedule_expression field on the resulting resource block. When null, the schedule_expression field will be omitted from the resulting object.
• sync_compliance (string): Set the sync_compliance field on the resulting resource block. When null, the sync_compliance field will be omitted from the resulting object.
• wait_for_success_timeout_seconds (number): Set the wait_for_success_timeout_seconds field on the resulting resource block. When null, the wait_for_success_timeout_seconds field will be omitted from the resulting object.
• output_location (list[obj]): Set the output_location field on the resulting resource block. When null, the output_location sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ssm_association.output_location.new constructor.
• targets (list[obj]): Set the targets field on the resulting resource block. When null, the targets sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ssm_association.targets.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.ssm_association.newAttrs constructs a new object with attributes and blocks configured for the ssm_association Terraform resource.

Unlike aws.ssm_association.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• apply_only_at_cron_interval (bool): Set the apply_only_at_cron_interval field on the resulting object. When null, the apply_only_at_cron_interval field will be omitted from the resulting object.
• association_name (string): Set the association_name field on the resulting object. When null, the association_name field will be omitted from the resulting object.
• automation_target_parameter_name (string): Set the automation_target_parameter_name field on the resulting object. When null, the automation_target_parameter_name field will be omitted from the resulting object.
• compliance_severity (string): Set the compliance_severity field on the resulting object. When null, the compliance_severity field will be omitted from the resulting object.
• document_version (string): Set the document_version field on the resulting object. When null, the document_version field will be omitted from the resulting object.
• instance_id (string): Set the instance_id field on the resulting object. When null, the instance_id field will be omitted from the resulting object.
• max_concurrency (string): Set the max_concurrency field on the resulting object. When null, the max_concurrency field will be omitted from the resulting object.
• max_errors (string): Set the max_errors field on the resulting object. When null, the max_errors field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object.
• parameters (obj): Set the parameters field on the resulting object. When null, the parameters field will be omitted from the resulting object.
• schedule_expression (string): Set the schedule_expression field on the resulting object. When null, the schedule_expression field will be omitted from the resulting object.
• sync_compliance (string): Set the sync_compliance field on the resulting object. When null, the sync_compliance field will be omitted from the resulting object.
• wait_for_success_timeout_seconds (number): Set the wait_for_success_timeout_seconds field on the resulting object. When null, the wait_for_success_timeout_seconds field will be omitted from the resulting object.
• output_location (list[obj]): Set the output_location field on the resulting object. When null, the output_location sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ssm_association.output_location.new constructor.
• targets (list[obj]): Set the targets field on the resulting object. When null, the targets sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ssm_association.targets.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new ssm_association resource into the root Terraform configuration.

fn withApplyOnlyAtCronInterval

withApplyOnlyAtCronInterval()

aws.bool.withApplyOnlyAtCronInterval constructs a mixin object that can be merged into the bool Terraform resource block to set or update the apply_only_at_cron_interval field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the apply_only_at_cron_interval field.

fn withAssociationName

withAssociationName()

aws.string.withAssociationName constructs a mixin object that can be merged into the string Terraform resource block to set or update the association_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the association_name field.

fn withAutomationTargetParameterName

withAutomationTargetParameterName()

aws.string.withAutomationTargetParameterName constructs a mixin object that can be merged into the string Terraform resource block to set or update the automation_target_parameter_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the automation_target_parameter_name field.

fn withComplianceSeverity

withComplianceSeverity()

aws.string.withComplianceSeverity constructs a mixin object that can be merged into the string Terraform resource block to set or update the compliance_severity field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the compliance_severity field.

fn withDocumentVersion

withDocumentVersion()

aws.string.withDocumentVersion constructs a mixin object that can be merged into the string Terraform resource block to set or update the document_version field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the document_version field.

fn withInstanceId

withInstanceId()

aws.string.withInstanceId constructs a mixin object that can be merged into the string Terraform resource block to set or update the instance_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the instance_id field.

fn withMaxConcurrency

withMaxConcurrency()

aws.string.withMaxConcurrency constructs a mixin object that can be merged into the string Terraform resource block to set or update the max_concurrency field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the max_concurrency field.

fn withMaxErrors

withMaxErrors()

aws.string.withMaxErrors constructs a mixin object that can be merged into the string Terraform resource block to set or update the max_errors field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the max_errors field.

fn withName

withName()

aws.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the name field.

fn withOutputLocation

withOutputLocation()

aws.list[obj].withOutputLocation constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the output_location field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withOutputLocationMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the output_location field.

fn withOutputLocationMixin

withOutputLocationMixin()

aws.list[obj].withOutputLocationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the output_location field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withOutputLocation function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the output_location field.

fn withParameters

withParameters()

aws.obj.withParameters constructs a mixin object that can be merged into the obj Terraform resource block to set or update the parameters field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the parameters field.

fn withScheduleExpression

withScheduleExpression()

aws.string.withScheduleExpression constructs a mixin object that can be merged into the string Terraform resource block to set or update the schedule_expression field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the schedule_expression field.

fn withSyncCompliance

withSyncCompliance()

aws.string.withSyncCompliance constructs a mixin object that can be merged into the string Terraform resource block to set or update the sync_compliance field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the sync_compliance field.

fn withTargets

withTargets()

aws.list[obj].withTargets constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the targets field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withTargetsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the targets field.

fn withTargetsMixin

withTargetsMixin()

aws.list[obj].withTargetsMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the targets field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withTargets function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the targets field.

fn withWaitForSuccessTimeoutSeconds

withWaitForSuccessTimeoutSeconds()

aws.number.withWaitForSuccessTimeoutSeconds constructs a mixin object that can be merged into the number Terraform resource block to set or update the wait_for_success_timeout_seconds field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the wait_for_success_timeout_seconds field.

obj output_location

fn output_location.new

new()

aws.ssm_association.output_location.new constructs a new object with attributes and blocks configured for the output_location Terraform sub block.

Args:

• s3_bucket_name (string): Set the s3_bucket_name field on the resulting object.
• s3_key_prefix (string): Set the s3_key_prefix field on the resulting object. When null, the s3_key_prefix field will be omitted from the resulting object.
• s3_region (string): Set the s3_region field on the resulting object. When null, the s3_region field will be omitted from the resulting object.

Returns:

• An attribute object that represents the output_location sub block.

obj targets

fn targets.new

new()

aws.ssm_association.targets.new constructs a new object with attributes and blocks configured for the targets Terraform sub block.

Args:

• key (string): Set the key field on the resulting object.
• values (list): Set the values field on the resulting object.

Returns:

• An attribute object that represents the targets sub block.