Edit This Page

ssm

class pulumi_aws.ssm.Activation(resource_name, opts=None, description=None, expiration_date=None, iam_role=None, name=None, registration_limit=None, __name__=None, __opts__=None)

Registers an on-premises server or virtual machine with Amazon EC2 so that it can be managed using Run Command.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the resource that you want to register.
  • expiration_date (pulumi.Input[str]) – A timestamp in RFC3339 format by which this activation request should expire. The default value is 24 hours from resource creation time.
  • iam_role (pulumi.Input[str]) – The IAM Role to attach to the managed instance.
  • name (pulumi.Input[str]) – The default name of the registered managed instance.
  • registration_limit (pulumi.Input[int]) – The maximum number of managed instances you want to register. The default value is 1 instance.
activation_code = None

The code the system generates when it processes the activation.

description = None

The description of the resource that you want to register.

expiration_date = None

A timestamp in RFC3339 format by which this activation request should expire. The default value is 24 hours from resource creation time.

expired = None

If the current activation has expired.

iam_role = None

The IAM Role to attach to the managed instance.

name = None

The default name of the registered managed instance.

registration_count = None

The number of managed instances that are currently registered using this activation.

registration_limit = None

The maximum number of managed instances you want to register. The default value is 1 instance.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.Association(resource_name, opts=None, association_name=None, document_version=None, instance_id=None, name=None, output_location=None, parameters=None, schedule_expression=None, targets=None, __name__=None, __opts__=None)

Associates an SSM Document to an instance or EC2 tag.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • association_name (pulumi.Input[str]) – The descriptive name for the association.
  • document_version (pulumi.Input[str]) – The document version you want to associate with the target(s). Can be a specific version or the default version.
  • instance_id (pulumi.Input[str]) – The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.
  • name (pulumi.Input[str]) – The name of the SSM document to apply.
  • output_location (pulumi.Input[dict]) – An output location block. Output Location is documented below.
  • parameters (pulumi.Input[dict]) – A block of arbitrary string parameters to pass to the SSM document.
  • schedule_expression (pulumi.Input[str]) – A cron expression when the association will be applied to the target(s).
  • targets (pulumi.Input[list]) – A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.
association_name = None

The descriptive name for the association.

document_version = None

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

instance_id = None

The instance ID to apply an SSM document to. Use targets with key InstanceIds for document schema versions 2.0 and above.

name = None

The name of the SSM document to apply.

output_location = None

An output location block. Output Location is documented below.

parameters = None

A block of arbitrary string parameters to pass to the SSM document.

schedule_expression = None

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

targets = None

A block containing the targets of the SSM association. Targets are documented below. AWS currently supports a maximum of 5 targets.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.Document(resource_name, opts=None, content=None, document_format=None, document_type=None, name=None, permissions=None, tags=None, __name__=None, __opts__=None)

Provides an SSM Document resource

NOTE on updating SSM documents: Only documents with a schema version of 2.0 or greater can update their content once created, see [SSM Schema Features][1]. To update a document with an older schema version you must recreate the resource.

The permissions attribute specifies how you want to share the document. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

The permissions mapping supports the following:

  • type - The permission type for the document. The permission type can be Share.
  • account_ids - The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • content (pulumi.Input[str]) – The JSON or YAML content of the document.
  • document_format (pulumi.Input[str]) – The format of the document. Valid document types include: JSON and YAML
  • document_type (pulumi.Input[str]) – The type of the document. Valid document types include: Command, Policy, Automation and Session
  • name (pulumi.Input[str]) – The name of the document.
  • permissions (pulumi.Input[dict]) – Additional Permissions to attach to the document. See Permissions below for details.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the object.
content = None

The JSON or YAML content of the document.

created_date = None

The date the document was created.

default_version = None

The default version of the document.

description = None

The description of the document.

document_format = None

The format of the document. Valid document types include: JSON and YAML

document_type = None

The type of the document. Valid document types include: Command, Policy, Automation and Session

hash = None

The sha1 or sha256 of the document content

hash_type = None

“Sha1” “Sha256”. The hashing algorithm used when hashing the content.

latest_version = None

The latest version of the document.

name = None

The name of the document.

owner = None

The AWS user account of the person who created the document.

parameters = None

The parameters that are available to this document.

permissions = None

Additional Permissions to attach to the document. See Permissions below for details.

platform_types = None

A list of OS platforms compatible with this SSM document, either “Windows” or “Linux”.

schema_version = None

The schema version of the document.

status = None

“Creating”, “Active” or “Deleting”. The current status of the document.

tags = None

A mapping of tags to assign to the object.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.GetDocumentResult(arn=None, content=None, document_type=None, id=None)

A collection of values returned by getDocument.

arn = None

The ARN of the document.

content = None

The contents of the document.

document_type = None

The type of the document.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.ssm.GetParameterResult(arn=None, type=None, value=None, id=None)

A collection of values returned by getParameter.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.ssm.MaintenanceWindow(resource_name, opts=None, allow_unassociated_targets=None, cutoff=None, duration=None, enabled=None, end_date=None, name=None, schedule=None, schedule_timezone=None, start_date=None, __name__=None, __opts__=None)

Provides an SSM Maintenance Window resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allow_unassociated_targets (pulumi.Input[bool]) – Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.
  • cutoff (pulumi.Input[int]) – The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.
  • duration (pulumi.Input[int]) – The duration of the Maintenance Window in hours.
  • enabled (pulumi.Input[bool]) – Whether the maintenance window is enabled. Default: true.
  • end_date (pulumi.Input[str]) – Timestamp in ISO-8601 extended format when to no longer run the maintenance window.
  • name (pulumi.Input[str]) – The name of the maintenance window.
  • schedule (pulumi.Input[str]) – The schedule of the Maintenance Window in the form of a cron or rate expression.
  • schedule_timezone (pulumi.Input[str]) – Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.
  • start_date (pulumi.Input[str]) –

    Timestamp in ISO-8601 extended format when to begin the maintenance window.
allow_unassociated_targets = None

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

cutoff = None

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

duration = None

The duration of the Maintenance Window in hours.

enabled = None

Whether the maintenance window is enabled. Default: true.

end_date = None

Timestamp in ISO-8601 extended format when to no longer run the maintenance window.

name = None

The name of the maintenance window.

schedule = None

The schedule of the Maintenance Window in the form of a cron or rate expression.

schedule_timezone = None

Timezone for schedule in Internet Assigned Numbers Authority (IANA) Time Zone Database format. For example: America/Los_Angeles, etc/UTC, or Asia/Seoul.

start_date = None

Timestamp in ISO-8601 extended format when to begin the maintenance window.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.MaintenanceWindowTarget(resource_name, opts=None, owner_information=None, resource_type=None, targets=None, window_id=None, __name__=None, __opts__=None)

Provides an SSM Maintenance Window Target resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • owner_information (pulumi.Input[str]) – User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.
  • resource_type (pulumi.Input[str]) – The type of target being registered with the Maintenance Window. Possible values INSTANCE.
  • targets (pulumi.Input[list]) – The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=tag name,Values=tag value.
  • window_id (pulumi.Input[str]) – The Id of the maintenance window to register the target with.
owner_information = None

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

resource_type = None

The type of target being registered with the Maintenance Window. Possible values INSTANCE.

targets = None

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=tag name,Values=tag value.

window_id = None

The Id of the maintenance window to register the target with.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.MaintenanceWindowTask(resource_name, opts=None, description=None, logging_info=None, max_concurrency=None, max_errors=None, name=None, priority=None, service_role_arn=None, targets=None, task_arn=None, task_parameters=None, task_type=None, window_id=None, __name__=None, __opts__=None)

Provides an SSM Maintenance Window Task resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the maintenance window task.
  • logging_info (pulumi.Input[dict]) – A structure containing information about an Amazon S3 bucket to write instance-level logs to. Documented below.
  • max_concurrency (pulumi.Input[str]) – The maximum number of targets this task can be run for in parallel.
  • max_errors (pulumi.Input[str]) – The maximum number of errors allowed before this task stops being scheduled.

:param pulumi.Input[str] name :param pulumi.Input[int] priority: The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel. :param pulumi.Input[str] service_role_arn: The role that should be assumed when executing the task. :param pulumi.Input[list] targets: The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2. :param pulumi.Input[str] task_arn: The ARN of the task to execute. :param pulumi.Input[list] task_parameters: A structure containing information about parameters required by the particular task_arn. Documented below. :param pulumi.Input[str] task_type: The type of task being registered. The only allowed value is RUN_COMMAND. :param pulumi.Input[str] window_id: The Id of the maintenance window to register the task with.

description = None

The description of the maintenance window task.

logging_info = None

A structure containing information about an Amazon S3 bucket to write instance-level logs to. Documented below.

max_concurrency = None

The maximum number of targets this task can be run for in parallel.

max_errors = None

The maximum number of errors allowed before this task stops being scheduled.

priority = None

The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

service_role_arn = None

The role that should be assumed when executing the task.

targets = None

The targets (either instances or window target ids). Instances are specified using Key=InstanceIds,Values=instanceid1,instanceid2. Window target ids are specified using Key=WindowTargetIds,Values=window target id1, window target id2.

task_arn = None

The ARN of the task to execute.

task_parameters = None

A structure containing information about parameters required by the particular task_arn. Documented below.

task_type = None

The type of task being registered. The only allowed value is RUN_COMMAND.

window_id = None

The Id of the maintenance window to register the task with.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.Parameter(resource_name, opts=None, allowed_pattern=None, arn=None, description=None, key_id=None, name=None, overwrite=None, tags=None, type=None, value=None, __name__=None, __opts__=None)

Provides an SSM Parameter resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allowed_pattern (pulumi.Input[str]) – A regular expression used to validate the parameter value.
  • arn (pulumi.Input[str]) – The ARN of the parameter.
  • description (pulumi.Input[str]) – The description of the parameter.
  • key_id (pulumi.Input[str]) – The KMS key id or arn for encrypting a SecureString.
  • name (pulumi.Input[str]) – The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
  • overwrite (pulumi.Input[bool]) – Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by terraform to avoid overwrite of existing resource and will default to true otherwise (terraform lifecycle rules should then be used to manage the update behavior).
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the object.
  • type (pulumi.Input[str]) – The type of the parameter. Valid types are String, StringList and SecureString.
  • value (pulumi.Input[str]) – The value of the parameter.
allowed_pattern = None

A regular expression used to validate the parameter value.

arn = None

The ARN of the parameter.

description = None

The description of the parameter.

key_id = None

The KMS key id or arn for encrypting a SecureString.

name = None

The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.

overwrite = None

Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by terraform to avoid overwrite of existing resource and will default to true otherwise (terraform lifecycle rules should then be used to manage the update behavior).

tags = None

A mapping of tags to assign to the object.

type = None

The type of the parameter. Valid types are String, StringList and SecureString.

value = None

The value of the parameter.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.PatchBaseline(resource_name, opts=None, approval_rules=None, approved_patches=None, approved_patches_compliance_level=None, description=None, global_filters=None, name=None, operating_system=None, rejected_patches=None, __name__=None, __opts__=None)

Provides an SSM Patch Baseline resource

NOTE on Patch Baselines: The approved_patches and approval_rule are both marked as optional fields, but the Patch Baseline requires that at least one of them is specified.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • approval_rules (pulumi.Input[list]) – A set of rules used to include patches in the baseline. up to 10 approval rules can be specified. Each approval_rule block requires the fields documented below.
  • approved_patches (pulumi.Input[list]) – A list of explicitly approved patches for the baseline.
  • approved_patches_compliance_level (pulumi.Input[str]) – Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED.
  • description (pulumi.Input[str]) – The description of the patch baseline.
  • global_filters (pulumi.Input[list]) – A set of global filters used to exclude patches from the baseline. Up to 4 global filters can be specified using Key/Value pairs. Valid Keys are PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID.
  • name (pulumi.Input[str]) – The name of the patch baseline.
  • operating_system (pulumi.Input[str]) – Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, SUSE, UBUNTU, CENTOS, and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS.
  • rejected_patches (pulumi.Input[list]) – A list of rejected patches.
approval_rules = None

A set of rules used to include patches in the baseline. up to 10 approval rules can be specified. Each approval_rule block requires the fields documented below.

approved_patches = None

A list of explicitly approved patches for the baseline.

approved_patches_compliance_level = None

Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED. The default value is UNSPECIFIED.

description = None

The description of the patch baseline.

global_filters = None

A set of global filters used to exclude patches from the baseline. Up to 4 global filters can be specified using Key/Value pairs. Valid Keys are PRODUCT | CLASSIFICATION | MSRC_SEVERITY | PATCH_ID.

name = None

The name of the patch baseline.

operating_system = None

Defines the operating system the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, SUSE, UBUNTU, CENTOS, and REDHAT_ENTERPRISE_LINUX. The Default value is WINDOWS.

rejected_patches = None

A list of rejected patches.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.PatchGroup(resource_name, opts=None, baseline_id=None, patch_group=None, __name__=None, __opts__=None)

Provides an SSM Patch Group resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • baseline_id (pulumi.Input[str]) – The ID of the patch baseline to register the patch group with.
  • patch_group (pulumi.Input[str]) – The name of the patch group that should be registered with the patch baseline.
baseline_id = None

The ID of the patch baseline to register the patch group with.

patch_group = None

The name of the patch group that should be registered with the patch baseline.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.ssm.ResourceDataSync(resource_name, opts=None, name=None, s3_destination=None, __name__=None, __opts__=None)

Provides a SSM resource data sync.

s3_destination supports the following:

  • bucket_name - (Required) Name of S3 bucket where the aggregated data is stored.
  • region - (Required) Region with the bucket targeted by the Resource Data Sync.
  • kms_key_arn - (Optional) ARN of an encryption key for a destination in Amazon S3.
  • prefix - (Optional) Prefix for the bucket.
  • sync_format - (Optional) A supported sync format. Only JsonSerDe is currently supported. Defaults to JsonSerDe.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – Name for the configuration.
  • s3_destination (pulumi.Input[dict]) – Amazon S3 configuration details for the sync.
name = None

Name for the configuration.

s3_destination = None

Amazon S3 configuration details for the sync.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.ssm.get_document(document_format=None, document_version=None, name=None)

Gets the contents of the specified Systems Manager document.

pulumi_aws.ssm.get_parameter(name=None, with_decryption=None)

Provides an SSM Parameter data source.