aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
962 lines • 132 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* The `AWS::SSM::Association` resource creates a State Manager association for your managed instances.
*
* A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Groups or an AWS Auto Scaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
*
* @cloudformationResource AWS::SSM::Association
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
*/
export declare class CfnAssociation extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAssociation from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAssociation;
/**
* The association ID.
*
* @cloudformationAttribute AssociationId
*/
readonly attrAssociationId: string;
/**
* By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.
*/
applyOnlyAtCronInterval?: boolean | cdk.IResolvable;
/**
* Specify a descriptive name for the association.
*/
associationName?: string;
/**
* Choose the parameter that will define how your automation will branch out.
*/
automationTargetParameterName?: string;
/**
* The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
*/
calendarNames?: Array<string>;
/**
* The severity level that is assigned to the association.
*/
complianceSeverity?: string;
/**
* The version of the SSM document to associate with the target.
*/
documentVersion?: string;
/**
* The ID of the instance that the SSM document is associated with.
*/
instanceId?: string;
/**
* The maximum number of targets allowed to run the association at the same time.
*/
maxConcurrency?: string;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
*/
maxErrors?: string;
/**
* The name of the SSM document that contains the configuration information for the instance.
*/
name: string;
/**
* An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
*/
outputLocation?: CfnAssociation.InstanceAssociationOutputLocationProperty | cdk.IResolvable;
/**
* The parameters for the runtime configuration of the document.
*/
parameters?: any | cdk.IResolvable;
/**
* A cron expression that specifies a schedule when the association runs.
*/
scheduleExpression?: string;
/**
* Number of days to wait after the scheduled day to run an association.
*/
scheduleOffset?: number;
/**
* The mode for generating association compliance.
*/
syncCompliance?: string;
/**
* The targets for the association.
*/
targets?: Array<cdk.IResolvable | CfnAssociation.TargetProperty> | cdk.IResolvable;
/**
* The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
*/
waitForSuccessTimeoutSeconds?: number;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnAssociationProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnAssociation {
/**
* `Target` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies the targets for an SSM document in Systems Manager . You can target all instances in an AWS account by specifying the `InstanceIds` key with a value of `*` . To view a JSON and a YAML example that targets all instances, see the example "Create an association for all managed instances in an AWS account " later in this page.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html
*/
interface TargetProperty {
/**
* User-defined criteria for sending commands that target managed nodes that meet the criteria.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key
*/
readonly key: string;
/**
* User-defined criteria that maps to `Key` .
*
* For example, if you specified `tag:ServerRole` , you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer` .
*
* Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values
*/
readonly values: Array<string>;
}
/**
* `InstanceAssociationOutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.
*
* For the minimal permissions required to enable Amazon S3 output for an association, see [Creating associations](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html) in the *Systems Manager User Guide* .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html
*/
interface InstanceAssociationOutputLocationProperty {
/**
* `S3OutputLocation` is a property of the [InstanceAssociationOutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html) property that specifies an Amazon S3 bucket where you want to store the results of this request.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location
*/
readonly s3Location?: cdk.IResolvable | CfnAssociation.S3OutputLocationProperty;
}
/**
* `S3OutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html
*/
interface S3OutputLocationProperty {
/**
* The name of the S3 bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname
*/
readonly outputS3BucketName?: string;
/**
* The S3 bucket subfolder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix
*/
readonly outputS3KeyPrefix?: string;
/**
* The AWS Region of the S3 bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3region
*/
readonly outputS3Region?: string;
}
}
/**
* Properties for defining a `CfnAssociation`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
*/
export interface CfnAssociationProps {
/**
* By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.
*
* Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval
*/
readonly applyOnlyAtCronInterval?: boolean | cdk.IResolvable;
/**
* Specify a descriptive name for the association.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname
*/
readonly associationName?: string;
/**
* Choose the parameter that will define how your automation will branch out.
*
* This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername
*/
readonly automationTargetParameterName?: string;
/**
* The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
*
* The associations only run when that Change Calendar is open. For more information, see [AWS Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the *AWS Systems Manager User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames
*/
readonly calendarNames?: Array<string>;
/**
* The severity level that is assigned to the association.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity
*/
readonly complianceSeverity?: string;
/**
* The version of the SSM document to associate with the target.
*
* > Note the following important information.
* >
* > - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the `default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default` .
* > - `DocumentVersion` is not valid for documents owned by AWS , such as `AWS-RunPatchBaseline` or `AWS-UpdateSSMAgent` . If you specify `DocumentVersion` for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: <token>, HandlerErrorCode: GeneralServiceException).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion
*/
readonly documentVersion?: string;
/**
* The ID of the instance that the SSM document is associated with.
*
* You must specify the `InstanceId` or `Targets` property.
*
* > `InstanceId` has been deprecated. To specify an instance ID for an association, use the `Targets` parameter. If you use the parameter `InstanceId` , you cannot use the parameters `AssociationName` , `DocumentVersion` , `MaxErrors` , `MaxConcurrency` , `OutputLocation` , or `ScheduleExpression` . To use these parameters, you must use the `Targets` parameter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid
*/
readonly instanceId?: string;
/**
* The maximum number of targets allowed to run the association at the same time.
*
* You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
*
* If a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency
*/
readonly maxConcurrency?: string;
/**
* The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
*
* You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received.
*
* Executions that are already running an association when `MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set `MaxConcurrency` to 1 so that executions proceed one at a time.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors
*/
readonly maxErrors?: string;
/**
* The name of the SSM document that contains the configuration information for the instance.
*
* You can specify `Command` or `Automation` documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format:
*
* `arn:partition:ssm:region:account-id:document/document-name`
*
* For example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`
*
* For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS -ApplyPatchBaseline` or `My-Document` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name
*/
readonly name: string;
/**
* An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation
*/
readonly outputLocation?: CfnAssociation.InstanceAssociationOutputLocationProperty | cdk.IResolvable;
/**
* The parameters for the runtime configuration of the document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters
*/
readonly parameters?: any | cdk.IResolvable;
/**
* A cron expression that specifies a schedule when the association runs.
*
* The schedule runs in Coordinated Universal Time (UTC).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression
*/
readonly scheduleExpression?: string;
/**
* Number of days to wait after the scheduled day to run an association.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset
*/
readonly scheduleOffset?: number;
/**
* The mode for generating association compliance.
*
* You can specify `AUTO` or `MANUAL` . In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT` . If the association execution doesn't run successfully, the association is `NON-COMPLIANT` .
*
* In `MANUAL` mode, you must specify the `AssociationId` as a parameter for the `PutComplianceItems` API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the `PutComplianceItems` API action.
*
* By default, all associations use `AUTO` mode.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance
*/
readonly syncCompliance?: string;
/**
* The targets for the association.
*
* You must specify the `InstanceId` or `Targets` property. You can target all instances in an AWS account by specifying t he `InstanceIds` key with a value of `*` .
*
* Supported formats include the following.
*
* - `Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>`
* - `Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>`
*
* To view a JSON and a YAML example that targets all instances, see "Create an association for all managed instances in an AWS account " on the Examples page.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets
*/
readonly targets?: Array<cdk.IResolvable | CfnAssociation.TargetProperty> | cdk.IResolvable;
/**
* The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
*
* If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.
*
* > When you specify a value for the `WaitForSuccessTimeoutSeconds` , [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) for your AWS CloudFormation stack’s configuration might yield inaccurate results. If drift detection is important in your scenario, we recommend that you don’t include `WaitForSuccessTimeoutSeconds` in your template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds
*/
readonly waitForSuccessTimeoutSeconds?: number;
}
/**
* The `AWS::SSM::Document` resource creates a Systems Manager (SSM) document in AWS Systems Manager .
*
* This document defines the actions that Systems Manager performs on your AWS resources.
*
* > This resource does not support AWS CloudFormation drift detection.
*
* @cloudformationResource AWS::SSM::Document
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
*/
export declare class CfnDocument extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDocument from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDocument;
/**
* A list of key-value pairs that describe attachments to a version of a document.
*/
attachments?: Array<CfnDocument.AttachmentsSourceProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The content for the new SSM document in JSON or YAML.
*/
content: any | cdk.IResolvable;
/**
* Specify the document format for the request.
*/
documentFormat?: string;
/**
* The type of document to create.
*/
documentType?: string;
/**
* A name for the SSM document.
*/
name?: string;
/**
* A list of SSM documents required by a document.
*/
requires?: Array<CfnDocument.DocumentRequiresProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* AWS CloudFormation resource tags to apply to the document.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* Specify a target type to define the kinds of resources the document can run on.
*/
targetType?: string;
/**
* If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.
*/
updateMethod?: string;
/**
* An optional field specifying the version of the artifact you are creating with the document.
*/
versionName?: string;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnDocumentProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnDocument {
/**
* An SSM document required by the current document.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html
*/
interface DocumentRequiresProperty {
/**
* The name of the required SSM document.
*
* The name can be an Amazon Resource Name (ARN).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name
*/
readonly name?: string;
/**
* The document version required by the current document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version
*/
readonly version?: string;
}
/**
* Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html
*/
interface AttachmentsSourceProperty {
/**
* The key of a key-value pair that identifies the location of an attachment to a document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key
*/
readonly key?: string;
/**
* The name of the document attachment file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name
*/
readonly name?: string;
/**
* The value of a key-value pair that identifies the location of an attachment to a document.
*
* The format for *Value* depends on the type of key you specify.
*
* - For the key *SourceUrl* , the value is an S3 bucket location. For example:
*
* `"Values": [ "s3://amzn-s3-demo-bucket/my-prefix" ]`
* - For the key *S3FileUrl* , the value is a file in an S3 bucket. For example:
*
* `"Values": [ "s3://amzn-s3-demo-bucket/my-prefix/my-file.py" ]`
* - For the key *AttachmentReference* , the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
*
* `"Values": [ "MyOtherDocument/3/my-other-file.py" ]`
*
* However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
*
* `"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values
*/
readonly values?: Array<string>;
}
}
/**
* Properties for defining a `CfnDocument`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
*/
export interface CfnDocumentProps {
/**
* A list of key-value pairs that describe attachments to a version of a document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments
*/
readonly attachments?: Array<CfnDocument.AttachmentsSourceProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The content for the new SSM document in JSON or YAML.
*
* For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide* .
*
* > This parameter also supports `String` data types.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content
*/
readonly content: any | cdk.IResolvable;
/**
* Specify the document format for the request.
*
* `JSON` is the default format.
*
* @default - "JSON"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat
*/
readonly documentFormat?: string;
/**
* The type of document to create.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype
*/
readonly documentType?: string;
/**
* A name for the SSM document.
*
* > You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
* >
* > - `aws`
* > - `amazon`
* > - `amzn`
* > - `AWSEC2`
* > - `AWSConfigRemediation`
* > - `AWSSupport`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name
*/
readonly name?: string;
/**
* A list of SSM documents required by a document.
*
* This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes. For more information, see [What is AWS AppConfig ?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires
*/
readonly requires?: Array<CfnDocument.DocumentRequiresProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* AWS CloudFormation resource tags to apply to the document.
*
* Use tags to help you identify and categorize resources.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* Specify a target type to define the kinds of resources the document can run on.
*
* For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance` . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype
*/
readonly targetType?: string;
/**
* If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.
*
* `Replace` is the default method. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created. When you specify `NewVersion` , the default version of the document is changed to the newly created version.
*
* @default - "Replace"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod
*/
readonly updateMethod?: string;
/**
* An optional field specifying the version of the artifact you are creating with the document.
*
* For example, `Release12.1` . This value is unique across all versions of a document, and can't be changed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname
*/
readonly versionName?: string;
}
/**
* The `AWS::SSM::MaintenanceWindow` resource represents general information about a maintenance window for AWS Systems Manager .
*
* Maintenance windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS), updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks.
*
* For more information, see [Systems Manager Maintenance Windows](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-maintenance.html) in the *AWS Systems Manager User Guide* and [CreateMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .
*
* @cloudformationResource AWS::SSM::MaintenanceWindow
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html
*/
export declare class CfnMaintenanceWindow extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnMaintenanceWindow from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindow;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
*/
allowUnassociatedTargets: boolean | cdk.IResolvable;
/**
* The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
*/
cutoff: number;
/**
* A description of the maintenance window.
*/
description?: string;
/**
* The duration of the maintenance window in hours.
*/
duration: number;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
*/
endDate?: string;
/**
* The name of the maintenance window.
*/
name: string;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*/
schedule: string;
/**
* The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
*/
scheduleOffset?: number;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
*/
scheduleTimezone?: string;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
*/
startDate?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnMaintenanceWindowProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnMaintenanceWindow`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html
*/
export interface CfnMaintenanceWindowProps {
/**
* Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.
*
* If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets
*/
readonly allowUnassociatedTargets: boolean | cdk.IResolvable;
/**
* The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff
*/
readonly cutoff: number;
/**
* A description of the maintenance window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description
*/
readonly description?: string;
/**
* The duration of the maintenance window in hours.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration
*/
readonly duration: number;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate
*/
readonly endDate?: string;
/**
* The name of the maintenance window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name
*/
readonly name: string;
/**
* The schedule of the maintenance window in the form of a cron or rate expression.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule
*/
readonly schedule: string;
/**
* The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset
*/
readonly scheduleOffset?: number;
/**
* The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone
*/
readonly scheduleTimezone?: string;
/**
* The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
*
* `StartDate` allows you to delay activation of the maintenance window until the specified future date.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate
*/
readonly startDate?: string;
/**
* Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
*
* Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* The `AWS::SSM::MaintenanceWindowTarget` resource registers a target with a maintenance window for AWS Systems Manager .
*
* For more information, see [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .
*
* @cloudformationResource AWS::SSM::MaintenanceWindowTarget
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html
*/
export declare class CfnMaintenanceWindowTarget extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnMaintenanceWindowTarget from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindowTarget;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* A description for the target.
*/
description?: string;
/**
* The name for the maintenance window target.
*/
name?: string;
/**
* A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
*/
ownerInformation?: string;
/**
* The type of target that is being registered with the maintenance window.
*/
resourceType: string;
/**
* The targets to register with the maintenance window.
*/
targets: Array<cdk.IResolvable | CfnMaintenanceWindowTarget.TargetsProperty> | cdk.IResolvable;
/**
* The ID of the maintenance window to register the target with.
*/
windowId: string;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnMaintenanceWindowTargetProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnMaintenanceWindowTarget {
/**
* The `Targets` property type specifies adding a target to a maintenance window target in AWS Systems Manager .
*
* `Targets` is a property of the [AWS::SSM::MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html) resource.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html
*/
interface TargetsProperty {
/**
* User-defined criteria for sending commands that target managed nodes that meet the criteria.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key
*/
readonly key: string;
/**
* User-defined criteria that maps to `Key` .
*
* For example, if you specified `tag:ServerRole` , you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer` .
*
* Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values
*/
readonly values: Array<string>;
}
}
/**
* Properties for defining a `CfnMaintenanceWindowTarget`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html
*/
export interface CfnMaintenanceWindowTargetProps {
/**
* A description for the target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description
*/
readonly description?: string;
/**
* The name for the maintenance window target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name
*/
readonly name?: string;
/**
* A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation
*/
readonly ownerInformation?: string;
/**
* The type of target that is being registered with the maintenance window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype
*/
readonly resourceType: string;
/**
* The targets to register with the maintenance window.
*
* In other words, the instances to run commands on when the maintenance window runs.
*
* You must specify targets by using the `WindowTargetIds` parameter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets
*/
readonly targets: Array<cdk.IResolvable | CfnMaintenanceWindowTarget.TargetsProperty> | cdk.IResolvable;
/**
* The ID of the maintenance window to register the target with.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid
*/
readonly windowId: string;
}
/**
* The `AWS::SSM::MaintenanceWindowTask` resource defines information about a task for an AWS Systems Manager maintenance window.
*
* For more information, see [RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .
*
* @cloudformationResource AWS::SSM::MaintenanceWindowTask
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html
*/
export declare class CfnMaintenanceWindowTask extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnMaintenanceWindowTask from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMaintenanceWindowTask;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
*/
cutoffBehavior?: string;
/**
* A description of the task.
*/
description?: string;
/**
* Information about an Amazon S3 bucket to write Run Command task-level logs to.
*/
loggingInfo?: cdk.IResolvable | CfnMaintenanceWindowTask.LoggingInfoProperty;
/**
* The maximum number of targets this task can be run for, in parallel.
*/
ma