Module ssm

@pulumi/aws > ssm

Index

ssm/activation.ts ssm/association.ts ssm/document.ts ssm/getDocument.ts ssm/getParameter.ts ssm/maintenanceWindow.ts ssm/maintenanceWindowTarget.ts ssm/maintenanceWindowTask.ts ssm/parameter.ts ssm/patchBaseline.ts ssm/patchGroup.ts ssm/resourceDataSync.ts

class Activation

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

constructor

new Activation(name: string, args: ActivationArgs, opts?: pulumi.CustomResourceOptions)

Create a Activation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActivationState): Activation

Get an existing Activation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property activationCode

public activationCode: pulumi.Output<string>;

The code the system generates when it processes the activation.

property description

public description: pulumi.Output<string | undefined>;

The description of the resource that you want to register.

property expirationDate

public expirationDate: pulumi.Output<string | undefined>;

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

property expired

public expired: pulumi.Output<string>;

If the current activation has expired.

property iamRole

public iamRole: pulumi.Output<string>;

The IAM Role to attach to the managed instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The default name of the registered managed instance.

property registrationCount

public registrationCount: pulumi.Output<number>;

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

property registrationLimit

public registrationLimit: pulumi.Output<number | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Association

Associates an SSM Document to an instance or EC2 tag.

constructor

new Association(name: string, args?: AssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a Association resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AssociationState): Association

Get an existing Association resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property associationId

public associationId: pulumi.Output<string>;

property associationName

public associationName: pulumi.Output<string | undefined>;

The descriptive name for the association.

property documentVersion

public documentVersion: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string | undefined>;

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

property name

public name: pulumi.Output<string>;

The name of the SSM document to apply.

property outputLocation

public outputLocation: pulumi.Output<{ ... } | undefined>;

An output location block. Output Location is documented below.

property parameters

public parameters: pulumi.Output<{ ... }>;

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

property scheduleExpression

public scheduleExpression: pulumi.Output<string | undefined>;

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

property targets

public targets: pulumi.Output<{ ... }[]>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Document

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.

constructor

new Document(name: string, args: DocumentArgs, opts?: pulumi.CustomResourceOptions)

Create a Document resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DocumentState): Document

Get an existing Document resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property content

public content: pulumi.Output<string>;

The JSON or YAML content of the document.

property createdDate

public createdDate: pulumi.Output<string>;

The date the document was created.

property defaultVersion

public defaultVersion: pulumi.Output<string>;

The default version of the document.

property description

public description: pulumi.Output<string>;

The description of the document.

property documentFormat

public documentFormat: pulumi.Output<string | undefined>;

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

property documentType

public documentType: pulumi.Output<string>;

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

property hash

public hash: pulumi.Output<string>;

The sha1 or sha256 of the document content

property hashType

public hashType: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property latestVersion

public latestVersion: pulumi.Output<string>;

The latest version of the document.

property name

public name: pulumi.Output<string>;

The name of the document.

property owner

public owner: pulumi.Output<string>;

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

property parameters

public parameters: pulumi.Output<{ ... }[]>;

The parameters that are available to this document.

property permissions

public permissions: pulumi.Output<{ ... } | undefined>;

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

property platformTypes

public platformTypes: pulumi.Output<string[]>;

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

property schemaVersion

public schemaVersion: pulumi.Output<string>;

The schema version of the document.

property status

public status: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the object.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class MaintenanceWindow

Provides an SSM Maintenance Window resource

constructor

new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: pulumi.CustomResourceOptions)

Create a MaintenanceWindow resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MaintenanceWindowState): MaintenanceWindow

Get an existing MaintenanceWindow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowUnassociatedTargets

public allowUnassociatedTargets: pulumi.Output<boolean | undefined>;

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

property cutoff

public cutoff: pulumi.Output<number>;

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

property duration

public duration: pulumi.Output<number>;

The duration of the Maintenance Window in hours.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the maintenance window.

property schedule

public schedule: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class MaintenanceWindowTarget

Provides an SSM Maintenance Window Target resource

constructor

new MaintenanceWindowTarget(name: string, args: MaintenanceWindowTargetArgs, opts?: pulumi.CustomResourceOptions)

Create a MaintenanceWindowTarget resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MaintenanceWindowTargetState): MaintenanceWindowTarget

Get an existing MaintenanceWindowTarget resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ownerInformation

public ownerInformation: pulumi.Output<string | undefined>;

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

property resourceType

public resourceType: pulumi.Output<string>;

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

property targets

public targets: pulumi.Output<{ ... }[]>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property windowId

public windowId: pulumi.Output<string>;

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

class MaintenanceWindowTask

Provides an SSM Maintenance Window Task resource

constructor

new MaintenanceWindowTask(name: string, args: MaintenanceWindowTaskArgs, opts?: pulumi.CustomResourceOptions)

Create a MaintenanceWindowTask resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MaintenanceWindowTaskState): MaintenanceWindowTask

Get an existing MaintenanceWindowTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the maintenance window task.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property loggingInfo

public loggingInfo: pulumi.Output<{ ... } | undefined>;

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

property maxConcurrency

public maxConcurrency: pulumi.Output<string>;

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

property maxErrors

public maxErrors: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

property priority

public priority: pulumi.Output<number | undefined>;

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.

property serviceRoleArn

public serviceRoleArn: pulumi.Output<string>;

The role that should be assumed when executing the task.

property targets

public targets: pulumi.Output<{ ... }[]>;

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.

property taskArn

public taskArn: pulumi.Output<string>;

The ARN of the task to execute.

property taskParameters

public taskParameters: pulumi.Output<{ ... }[] | undefined>;

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

property taskType

public taskType: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property windowId

public windowId: pulumi.Output<string>;

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

class Parameter

Provides an SSM Parameter resource.

constructor

new Parameter(name: string, args: ParameterArgs, opts?: pulumi.CustomResourceOptions)

Create a Parameter resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterState): Parameter

Get an existing Parameter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowedPattern

public allowedPattern: pulumi.Output<string | undefined>;

A regular expression used to validate the parameter value.

property arn

public arn: pulumi.Output<string>;

The ARN of the parameter.

property description

public description: pulumi.Output<string | undefined>;

The description of the parameter.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keyId

public keyId: pulumi.Output<string>;

The KMS key id or arn for encrypting a SecureString.

property name

public name: pulumi.Output<string>;

The name of the parameter.

property overwrite

public overwrite: pulumi.Output<boolean | undefined>;

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).

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the object.

property type

public type: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The value of the parameter.

class PatchBaseline

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.

constructor

new PatchBaseline(name: string, args?: PatchBaselineArgs, opts?: pulumi.CustomResourceOptions)

Create a PatchBaseline resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PatchBaselineState): PatchBaseline

Get an existing PatchBaseline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property approvalRules

public approvalRules: pulumi.Output<{ ... }[] | undefined>;

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.

property approvedPatches

public approvedPatches: pulumi.Output<string[] | undefined>;

A list of explicitly approved patches for the baseline.

property approvedPatchesComplianceLevel

public approvedPatchesComplianceLevel: pulumi.Output<string | undefined>;

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.

property description

public description: pulumi.Output<string | undefined>;

The description of the patch baseline.

property globalFilters

public globalFilters: pulumi.Output<{ ... }[] | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the patch baseline.

property operatingSystem

public operatingSystem: pulumi.Output<string | undefined>;

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.

property rejectedPatches

public rejectedPatches: pulumi.Output<string[] | undefined>;

A list of rejected patches.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class PatchGroup

Provides an SSM Patch Group resource

constructor

new PatchGroup(name: string, args: PatchGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a PatchGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PatchGroupState): PatchGroup

Get an existing PatchGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property baselineId

public baselineId: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property patchGroup

public patchGroup: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ResourceDataSync

Provides a SSM resource data sync.

constructor

new ResourceDataSync(name: string, args: ResourceDataSyncArgs, opts?: pulumi.CustomResourceOptions)

Create a ResourceDataSync resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ResourceDataSyncState): ResourceDataSync

Get an existing ResourceDataSync resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name for the configuration.

property s3Destination

public s3Destination: pulumi.Output<{ ... }>;

Amazon S3 configuration details for the sync.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getDocument

getDocument(args: GetDocumentArgs, opts?: pulumi.InvokeOptions): Promise<GetDocumentResult>

Gets the contents of the specified Systems Manager document.

function getParameter

getParameter(args: GetParameterArgs, opts?: pulumi.InvokeOptions): Promise<GetParameterResult>

Provides an SSM Parameter data source.

interface ActivationArgs

The set of arguments for constructing a Activation resource.

property description

description?: pulumi.Input<string>;

The description of the resource that you want to register.

property expirationDate

expirationDate?: pulumi.Input<string>;

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

property iamRole

iamRole: pulumi.Input<string>;

The IAM Role to attach to the managed instance.

property name

name?: pulumi.Input<string>;

The default name of the registered managed instance.

property registrationLimit

registrationLimit?: pulumi.Input<number>;

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

interface ActivationState

Input properties used for looking up and filtering Activation resources.

property activationCode

activationCode?: pulumi.Input<string>;

The code the system generates when it processes the activation.

property description

description?: pulumi.Input<string>;

The description of the resource that you want to register.

property expirationDate

expirationDate?: pulumi.Input<string>;

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

property expired

expired?: pulumi.Input<string>;

If the current activation has expired.

property iamRole

iamRole?: pulumi.Input<string>;

The IAM Role to attach to the managed instance.

property name

name?: pulumi.Input<string>;

The default name of the registered managed instance.

property registrationCount

registrationCount?: pulumi.Input<number>;

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

property registrationLimit

registrationLimit?: pulumi.Input<number>;

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

interface AssociationArgs

The set of arguments for constructing a Association resource.

property associationName

associationName?: pulumi.Input<string>;

The descriptive name for the association.

property documentVersion

documentVersion?: pulumi.Input<string>;

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

property instanceId

instanceId?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the SSM document to apply.

property outputLocation

outputLocation?: pulumi.Input<{ ... }>;

An output location block. Output Location is documented below.

property parameters

parameters?: pulumi.Input<{ ... }>;

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

property scheduleExpression

scheduleExpression?: pulumi.Input<string>;

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

property targets

targets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

interface AssociationState

Input properties used for looking up and filtering Association resources.

property associationId

associationId?: pulumi.Input<string>;

property associationName

associationName?: pulumi.Input<string>;

The descriptive name for the association.

property documentVersion

documentVersion?: pulumi.Input<string>;

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

property instanceId

instanceId?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the SSM document to apply.

property outputLocation

outputLocation?: pulumi.Input<{ ... }>;

An output location block. Output Location is documented below.

property parameters

parameters?: pulumi.Input<{ ... }>;

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

property scheduleExpression

scheduleExpression?: pulumi.Input<string>;

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

property targets

targets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

interface DocumentArgs

The set of arguments for constructing a Document resource.

property content

content: pulumi.Input<string>;

The JSON or YAML content of the document.

property documentFormat

documentFormat?: pulumi.Input<string>;

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

property documentType

documentType: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the document.

property permissions

permissions?: pulumi.Input<{ ... }>;

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

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the object.

interface DocumentState

Input properties used for looking up and filtering Document resources.

property arn

arn?: pulumi.Input<string>;

property content

content?: pulumi.Input<string>;

The JSON or YAML content of the document.

property createdDate

createdDate?: pulumi.Input<string>;

The date the document was created.

property defaultVersion

defaultVersion?: pulumi.Input<string>;

The default version of the document.

property description

description?: pulumi.Input<string>;

The description of the document.

property documentFormat

documentFormat?: pulumi.Input<string>;

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

property documentType

documentType?: pulumi.Input<string>;

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

property hash

hash?: pulumi.Input<string>;

The sha1 or sha256 of the document content

property hashType

hashType?: pulumi.Input<string>;

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

property latestVersion

latestVersion?: pulumi.Input<string>;

The latest version of the document.

property name

name?: pulumi.Input<string>;

The name of the document.

property owner

owner?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

The parameters that are available to this document.

property permissions

permissions?: pulumi.Input<{ ... }>;

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

property platformTypes

platformTypes?: pulumi.Input<pulumi.Input<string>[]>;

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

property schemaVersion

schemaVersion?: pulumi.Input<string>;

The schema version of the document.

property status

status?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the object.

interface GetDocumentArgs

A collection of arguments for invoking getDocument.

property documentFormat

documentFormat?: string;

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

property documentVersion

documentVersion?: string;

The document version for which you want information.

property name

name: string;

The name of the Systems Manager document.

interface GetDocumentResult

A collection of values returned by getDocument.

property arn

arn: string;

The ARN of the document.

property content

content: string;

The contents of the document.

property documentType

documentType: string;

The type of the document.

property id

id: string;

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

interface GetParameterArgs

A collection of arguments for invoking getParameter.

property name

name: string;

The name of the parameter.

property withDecryption

withDecryption?: boolean;

Whether to return decrypted SecureString value. Defaults to true.

interface GetParameterResult

A collection of values returned by getParameter.

property arn

arn: string;

property id

id: string;

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

property type

type: string;

property value

value: string;

interface MaintenanceWindowArgs

The set of arguments for constructing a MaintenanceWindow resource.

property allowUnassociatedTargets

allowUnassociatedTargets?: pulumi.Input<boolean>;

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

property cutoff

cutoff: pulumi.Input<number>;

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

property duration

duration: pulumi.Input<number>;

The duration of the Maintenance Window in hours.

property enabled

enabled?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

The name of the maintenance window.

property schedule

schedule: pulumi.Input<string>;

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

interface MaintenanceWindowState

Input properties used for looking up and filtering MaintenanceWindow resources.

property allowUnassociatedTargets

allowUnassociatedTargets?: pulumi.Input<boolean>;

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

property cutoff

cutoff?: pulumi.Input<number>;

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

property duration

duration?: pulumi.Input<number>;

The duration of the Maintenance Window in hours.

property enabled

enabled?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

The name of the maintenance window.

property schedule

schedule?: pulumi.Input<string>;

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

interface MaintenanceWindowTargetArgs

The set of arguments for constructing a MaintenanceWindowTarget resource.

property ownerInformation

ownerInformation?: pulumi.Input<string>;

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

property resourceType

resourceType: pulumi.Input<string>;

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

property targets

targets: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property windowId

windowId: pulumi.Input<string>;

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

interface MaintenanceWindowTargetState

Input properties used for looking up and filtering MaintenanceWindowTarget resources.

property ownerInformation

ownerInformation?: pulumi.Input<string>;

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

property resourceType

resourceType?: pulumi.Input<string>;

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

property targets

targets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property windowId

windowId?: pulumi.Input<string>;

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

interface MaintenanceWindowTaskArgs

The set of arguments for constructing a MaintenanceWindowTask resource.

property description

description?: pulumi.Input<string>;

The description of the maintenance window task.

property loggingInfo

loggingInfo?: pulumi.Input<{ ... }>;

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

property maxConcurrency

maxConcurrency: pulumi.Input<string>;

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

property maxErrors

maxErrors: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

property priority

priority?: pulumi.Input<number>;

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.

property serviceRoleArn

serviceRoleArn: pulumi.Input<string>;

The role that should be assumed when executing the task.

property targets

targets: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property taskArn

taskArn: pulumi.Input<string>;

The ARN of the task to execute.

property taskParameters

taskParameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property taskType

taskType: pulumi.Input<string>;

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

property windowId

windowId: pulumi.Input<string>;

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

interface MaintenanceWindowTaskState

Input properties used for looking up and filtering MaintenanceWindowTask resources.

property description

description?: pulumi.Input<string>;

The description of the maintenance window task.

property loggingInfo

loggingInfo?: pulumi.Input<{ ... }>;

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

property maxConcurrency

maxConcurrency?: pulumi.Input<string>;

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

property maxErrors

maxErrors?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

property priority

priority?: pulumi.Input<number>;

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.

property serviceRoleArn

serviceRoleArn?: pulumi.Input<string>;

The role that should be assumed when executing the task.

property targets

targets?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property taskArn

taskArn?: pulumi.Input<string>;

The ARN of the task to execute.

property taskParameters

taskParameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property taskType

taskType?: pulumi.Input<string>;

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

property windowId

windowId?: pulumi.Input<string>;

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

interface ParameterArgs

The set of arguments for constructing a Parameter resource.

property allowedPattern

allowedPattern?: pulumi.Input<string>;

A regular expression used to validate the parameter value.

property arn

arn?: pulumi.Input<string>;

The ARN of the parameter.

property description

description?: pulumi.Input<string>;

The description of the parameter.

property keyId

keyId?: pulumi.Input<string>;

The KMS key id or arn for encrypting a SecureString.

property name

name?: pulumi.Input<string>;

The name of the parameter.

property overwrite

overwrite?: pulumi.Input<boolean>;

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).

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the object.

property type

type: pulumi.Input<string>;

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

property value

value: pulumi.Input<string>;

The value of the parameter.

interface ParameterState

Input properties used for looking up and filtering Parameter resources.

property allowedPattern

allowedPattern?: pulumi.Input<string>;

A regular expression used to validate the parameter value.

property arn

arn?: pulumi.Input<string>;

The ARN of the parameter.

property description

description?: pulumi.Input<string>;

The description of the parameter.

property keyId

keyId?: pulumi.Input<string>;

The KMS key id or arn for encrypting a SecureString.

property name

name?: pulumi.Input<string>;

The name of the parameter.

property overwrite

overwrite?: pulumi.Input<boolean>;

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).

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the object.

property type

type?: pulumi.Input<string>;

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

property value

value?: pulumi.Input<string>;

The value of the parameter.

interface PatchBaselineArgs

The set of arguments for constructing a PatchBaseline resource.

property approvalRules

approvalRules?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property approvedPatches

approvedPatches?: pulumi.Input<pulumi.Input<string>[]>;

A list of explicitly approved patches for the baseline.

property approvedPatchesComplianceLevel

approvedPatchesComplianceLevel?: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

The description of the patch baseline.

property globalFilters

globalFilters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property name

name?: pulumi.Input<string>;

The name of the patch baseline.

property operatingSystem

operatingSystem?: pulumi.Input<string>;

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.

property rejectedPatches

rejectedPatches?: pulumi.Input<pulumi.Input<string>[]>;

A list of rejected patches.

interface PatchBaselineState

Input properties used for looking up and filtering PatchBaseline resources.

property approvalRules

approvalRules?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property approvedPatches

approvedPatches?: pulumi.Input<pulumi.Input<string>[]>;

A list of explicitly approved patches for the baseline.

property approvedPatchesComplianceLevel

approvedPatchesComplianceLevel?: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

The description of the patch baseline.

property globalFilters

globalFilters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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.

property name

name?: pulumi.Input<string>;

The name of the patch baseline.

property operatingSystem

operatingSystem?: pulumi.Input<string>;

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.

property rejectedPatches

rejectedPatches?: pulumi.Input<pulumi.Input<string>[]>;

A list of rejected patches.

interface PatchGroupArgs

The set of arguments for constructing a PatchGroup resource.

property baselineId

baselineId: pulumi.Input<string>;

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

property patchGroup

patchGroup: pulumi.Input<string>;

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

interface PatchGroupState

Input properties used for looking up and filtering PatchGroup resources.

property baselineId

baselineId?: pulumi.Input<string>;

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

property patchGroup

patchGroup?: pulumi.Input<string>;

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

interface ResourceDataSyncArgs

The set of arguments for constructing a ResourceDataSync resource.

property name

name?: pulumi.Input<string>;

Name for the configuration.

property s3Destination

s3Destination: pulumi.Input<{ ... }>;

Amazon S3 configuration details for the sync.

interface ResourceDataSyncState

Input properties used for looking up and filtering ResourceDataSync resources.

property name

name?: pulumi.Input<string>;

Name for the configuration.

property s3Destination

s3Destination?: pulumi.Input<{ ... }>;

Amazon S3 configuration details for the sync.