{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-kms": "1.204.0", "@aws-cdk/cloud-assembly-schema": "1.204.0", "@aws-cdk/core": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::SSM", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "ssm" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-ssm", "readme": { "markdown": "# AWS Systems Manager Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Installation\n\nInstall the module:\n\n```console\n$ npm i @aws-cdk/aws-ssm\n```\n\nImport it into your code:\n\n```ts nofixture\nimport * as ssm from '@aws-cdk/aws-ssm';\n```\n\n## Using existing SSM Parameters in your CDK app\n\nYou can reference existing SSM Parameter Store values that you want to use in\nyour CDK app by using `ssm.StringParameter.fromStringParameterAttributes`:\n\n```ts lit=test/integ.parameter-store-string.lit.ts\n // Retrieve the latest value of the non-secret parameter\n // with name \"/My/String/Parameter\".\n const stringValue = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValue', {\n parameterName: '/My/Public/Parameter',\n // 'version' can be specified but is optional.\n }).stringValue;\n const stringValueVersionFromToken = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValueVersionFromToken', {\n parameterName: '/My/Public/Parameter',\n // parameter version from token\n version: parameterVersion,\n }).stringValue;\n\n // Retrieve a specific version of the secret (SecureString) parameter.\n // 'version' is always required.\n const secretValue = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValue', {\n parameterName: '/My/Secret/Parameter',\n version: 5,\n });\n const secretValueVersionFromToken = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValueVersionFromToken', {\n parameterName: '/My/Secret/Parameter',\n // parameter version from token\n version: parameterVersion,\n });\n\n```\n\n## Creating new SSM Parameters in your CDK app\n\nYou can create either `ssm.StringParameter` or `ssm.StringListParameter`s in\na CDK app. These are public (not secret) values. Parameters of type\n*SecureString* cannot be created directly from a CDK application; if you want\nto provision secrets automatically, use Secrets Manager Secrets (see the\n`@aws-cdk/aws-secretsmanager` package).\n\n```ts\nnew ssm.StringParameter(this, 'Parameter', {\n allowedPattern: '.*',\n description: 'The value Foo',\n parameterName: 'FooParameter',\n stringValue: 'Foo',\n tier: ssm.ParameterTier.ADVANCED,\n});\n```\n\n```ts lit=test/integ.parameter.lit.ts\n// Create a new SSM Parameter holding a String\nconst param = new ssm.StringParameter(stack, 'StringParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringValue: 'Initial parameter value',\n // allowedPattern: '.*',\n});\n\n// Grant read access to some Role\nparam.grantRead(role);\n\n// Create a new SSM Parameter holding a StringList\nconst listParameter = new ssm.StringListParameter(stack, 'StringListParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringListValue: ['Initial parameter value A', 'Initial parameter value B'],\n // allowedPattern: '.*',\n});\n```\n\nWhen specifying an `allowedPattern`, the values provided as string literals\nare validated against the pattern and an exception is raised if a value\nprovided does not comply.\n" }, "repository": { "directory": "packages/@aws-cdk/aws-ssm", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } }, "types": { "@aws-cdk/aws-ssm.CfnAssociation": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::Association", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.", "stability": "external", "summary": "A CloudFormation `AWS::SSM::Association`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\nconst cfnAssociation = new ssm.CfnAssociation(this, 'MyCfnAssociation', {\n name: 'name',\n\n // the properties below are optional\n applyOnlyAtCronInterval: false,\n associationName: 'associationName',\n automationTargetParameterName: 'automationTargetParameterName',\n calendarNames: ['calendarNames'],\n complianceSeverity: 'complianceSeverity',\n documentVersion: 'documentVersion',\n instanceId: 'instanceId',\n maxConcurrency: 'maxConcurrency',\n maxErrors: 'maxErrors',\n outputLocation: {\n s3Location: {\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n outputS3Region: 'outputS3Region',\n },\n },\n parameters: parameters,\n scheduleExpression: 'scheduleExpression',\n scheduleOffset: 123,\n syncCompliance: 'syncCompliance',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n waitForSuccessTimeoutSeconds: 123,\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnAssociation", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::Association`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 444 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnAssociationProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 266 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 474 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 501 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnAssociation", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 270 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "AssociationId" }, "stability": "external", "summary": "The association ID." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 295 }, "name": "attrAssociationId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 479 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name" }, "remarks": "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:\n\n`arn:partition:ssm:region:account-id:document/document-name`\n\nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`\n\nFor 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` .", "stability": "external", "summary": "The name of the SSM document that contains the configuration information for the instance." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 308 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters" }, "stability": "external", "summary": "The parameters for the runtime configuration of the document." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 396 }, "name": "parameters", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval" }, "remarks": "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.", "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 315 }, "name": "applyOnlyAtCronInterval", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname" }, "stability": "external", "summary": "Specify a descriptive name for the association." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 322 }, "name": "associationName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername" }, "remarks": "This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .", "stability": "external", "summary": "Choose the parameter that will define how your automation will branch out." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 329 }, "name": "automationTargetParameterName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames" }, "remarks": "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) .", "stability": "external", "summary": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 336 }, "name": "calendarNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity" }, "stability": "external", "summary": "The severity level that is assigned to the association." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 343 }, "name": "complianceSeverity", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion" }, "remarks": "> Note the following important information.\n>\n> - 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` .\n> - `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: , HandlerErrorCode: GeneralServiceException).", "stability": "external", "summary": "The version of the SSM document to associate with the target." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 355 }, "name": "documentVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid" }, "remarks": "You must specify the `InstanceId` or `Targets` property.\n\n> `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.", "stability": "external", "summary": "The ID of the instance that the SSM document is associated with." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 364 }, "name": "instanceId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency" }, "remarks": "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.\n\nIf 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` .", "stability": "external", "summary": "The maximum number of targets allowed to run the association at the same time." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 373 }, "name": "maxConcurrency", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors" }, "remarks": "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.\n\nExecutions 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.", "stability": "external", "summary": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 382 }, "name": "maxErrors", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation" }, "stability": "external", "summary": "An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 389 }, "name": "outputLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnAssociation.InstanceAssociationOutputLocationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression" }, "remarks": "The schedule runs in Coordinated Universal Time (UTC).", "stability": "external", "summary": "A cron expression that specifies a schedule when the association runs." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 403 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset" }, "stability": "external", "summary": "Number of days to wait after the scheduled day to run an association." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 410 }, "name": "scheduleOffset", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance" }, "remarks": "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` .\n\nIn `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.\n\nBy default, all associations use `AUTO` mode.", "stability": "external", "summary": "The mode for generating association compliance." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 421 }, "name": "syncCompliance", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets" }, "remarks": "You must specify the `InstanceId` or `Targets` property. 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 \"Create an association for all managed instances in an AWS account \" on the Examples page.", "stability": "external", "summary": "The targets for the association." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 428 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnAssociation.TargetProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds" }, "remarks": "If the association status doesn't show \"Success\" after the specified number of seconds, then stack creation fails.", "stability": "external", "summary": "The number of seconds the service should wait for the association status to show \"Success\" before proceeding with the stack execution." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 435 }, "name": "waitForSuccessTimeoutSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/ssm.generated:CfnAssociation" }, "@aws-cdk/aws-ssm.CfnAssociation.InstanceAssociationOutputLocationProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .", "stability": "external", "summary": "`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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst instanceAssociationOutputLocationProperty: ssm.CfnAssociation.InstanceAssociationOutputLocationProperty = {\n s3Location: {\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n outputS3Region: 'outputS3Region',\n },\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnAssociation.InstanceAssociationOutputLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 517 }, "name": "InstanceAssociationOutputLocationProperty", "namespace": "CfnAssociation", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location" }, "stability": "external", "summary": "`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." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 523 }, "name": "s3Location", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnAssociation.S3OutputLocationProperty" } ] } } } ], "symbolId": "lib/ssm.generated:CfnAssociation.InstanceAssociationOutputLocationProperty" }, "@aws-cdk/aws-ssm.CfnAssociation.S3OutputLocationProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst s3OutputLocationProperty: ssm.CfnAssociation.S3OutputLocationProperty = {\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n outputS3Region: 'outputS3Region',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnAssociation.S3OutputLocationProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 584 }, "name": "S3OutputLocationProperty", "namespace": "CfnAssociation", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname" }, "stability": "external", "summary": "The name of the S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 590 }, "name": "outputS3BucketName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix" }, "stability": "external", "summary": "The S3 bucket subfolder." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 596 }, "name": "outputS3KeyPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3region" }, "stability": "external", "summary": "The AWS Region of the S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 602 }, "name": "outputS3Region", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnAssociation.S3OutputLocationProperty" }, "@aws-cdk/aws-ssm.CfnAssociation.TargetProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "`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 \"Create an association for all managed instances in an AWS account \" on the Examples page.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst targetProperty: ssm.CfnAssociation.TargetProperty = {\n key: 'key',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnAssociation.TargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 669 }, "name": "TargetProperty", "namespace": "CfnAssociation", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key" }, "stability": "external", "summary": "User-defined criteria for sending commands that target managed nodes that meet the criteria." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 675 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values" }, "remarks": "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` .\n\nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.", "stability": "external", "summary": "User-defined criteria that maps to `Key` ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 683 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnAssociation.TargetProperty" }, "@aws-cdk/aws-ssm.CfnAssociationProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnAssociation`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\nconst cfnAssociationProps: ssm.CfnAssociationProps = {\n name: 'name',\n\n // the properties below are optional\n applyOnlyAtCronInterval: false,\n associationName: 'associationName',\n automationTargetParameterName: 'automationTargetParameterName',\n calendarNames: ['calendarNames'],\n complianceSeverity: 'complianceSeverity',\n documentVersion: 'documentVersion',\n instanceId: 'instanceId',\n maxConcurrency: 'maxConcurrency',\n maxErrors: 'maxErrors',\n outputLocation: {\n s3Location: {\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n outputS3Region: 'outputS3Region',\n },\n },\n parameters: parameters,\n scheduleExpression: 'scheduleExpression',\n scheduleOffset: 123,\n syncCompliance: 'syncCompliance',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n waitForSuccessTimeoutSeconds: 123,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnAssociationProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 19 }, "name": "CfnAssociationProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name" }, "remarks": "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:\n\n`arn:partition:ssm:region:account-id:document/document-name`\n\nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`\n\nFor 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` .", "stability": "external", "summary": "The name of the SSM document that contains the configuration information for the instance." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 32 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval" }, "remarks": "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.", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 39 }, "name": "applyOnlyAtCronInterval", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname" }, "stability": "external", "summary": "Specify a descriptive name for the association." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 46 }, "name": "associationName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername" }, "remarks": "This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .", "stability": "external", "summary": "Choose the parameter that will define how your automation will branch out." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 53 }, "name": "automationTargetParameterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames" }, "remarks": "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) .", "stability": "external", "summary": "The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 60 }, "name": "calendarNames", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity" }, "stability": "external", "summary": "The severity level that is assigned to the association." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 67 }, "name": "complianceSeverity", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion" }, "remarks": "> Note the following important information.\n>\n> - 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` .\n> - `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: , HandlerErrorCode: GeneralServiceException).", "stability": "external", "summary": "The version of the SSM document to associate with the target." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 79 }, "name": "documentVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid" }, "remarks": "You must specify the `InstanceId` or `Targets` property.\n\n> `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.", "stability": "external", "summary": "The ID of the instance that the SSM document is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 88 }, "name": "instanceId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency" }, "remarks": "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.\n\nIf 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` .", "stability": "external", "summary": "The maximum number of targets allowed to run the association at the same time." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 97 }, "name": "maxConcurrency", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors" }, "remarks": "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.\n\nExecutions 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.", "stability": "external", "summary": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 106 }, "name": "maxErrors", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation" }, "stability": "external", "summary": "An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 113 }, "name": "outputLocation", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnAssociation.InstanceAssociationOutputLocationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters" }, "stability": "external", "summary": "The parameters for the runtime configuration of the document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 120 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression" }, "remarks": "The schedule runs in Coordinated Universal Time (UTC).", "stability": "external", "summary": "A cron expression that specifies a schedule when the association runs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 127 }, "name": "scheduleExpression", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset" }, "stability": "external", "summary": "Number of days to wait after the scheduled day to run an association." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 134 }, "name": "scheduleOffset", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance" }, "remarks": "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` .\n\nIn `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.\n\nBy default, all associations use `AUTO` mode.", "stability": "external", "summary": "The mode for generating association compliance." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 145 }, "name": "syncCompliance", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets" }, "remarks": "You must specify the `InstanceId` or `Targets` property. 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 \"Create an association for all managed instances in an AWS account \" on the Examples page.", "stability": "external", "summary": "The targets for the association." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 152 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnAssociation.TargetProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds" }, "remarks": "If the association status doesn't show \"Success\" after the specified number of seconds, then stack creation fails.", "stability": "external", "summary": "The number of seconds the service should wait for the association status to show \"Success\" before proceeding with the stack execution." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 159 }, "name": "waitForSuccessTimeoutSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/ssm.generated:CfnAssociationProps" }, "@aws-cdk/aws-ssm.CfnDocument": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::Document", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\n> This resource does not support CloudFormation drift detection.", "stability": "external", "summary": "A CloudFormation `AWS::SSM::Document`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const content: any;\nconst cfnDocument = new ssm.CfnDocument(this, 'MyCfnDocument', {\n content: content,\n\n // the properties below are optional\n attachments: [{\n key: 'key',\n name: 'name',\n values: ['values'],\n }],\n documentFormat: 'documentFormat',\n documentType: 'documentType',\n name: 'name',\n requires: [{\n name: 'name',\n version: 'version',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n targetType: 'targetType',\n updateMethod: 'updateMethod',\n versionName: 'versionName',\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnDocument", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::Document`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1028 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnDocumentProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 916 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1050 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1070 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDocument", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 920 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1055 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags" }, "remarks": "Use tags to help you identify and categorize resources.", "stability": "external", "summary": "AWS CloudFormation resource tags to apply to the document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 998 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content" }, "remarks": "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* .\n\n> This parameter also supports `String` data types.", "stability": "external", "summary": "The content for the new SSM document in JSON or YAML." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 948 }, "name": "content", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments" }, "stability": "external", "summary": "A list of key-value pairs that describe attachments to a version of a document." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 955 }, "name": "attachments", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnDocument.AttachmentsSourceProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat" }, "remarks": "JSON is the default format.", "stability": "external", "summary": "Specify the document format for the request." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 962 }, "name": "documentFormat", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype" }, "remarks": "*Allowed Values* : `ApplicationConfigurationSchema` | `Automation` | `Automation.ChangeTemplate` | `Command` | `DeploymentStrategy` | `Package` | `Policy` | `Session`", "stability": "external", "summary": "The type of document to create." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 971 }, "name": "documentType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name" }, "remarks": "> You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:\n>\n> - `aws`\n> - `amazon`\n> - `amzn`", "stability": "external", "summary": "A name for the SSM document." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 984 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires" }, "remarks": "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* .", "stability": "external", "summary": "A list of SSM documents required by a document." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 991 }, "name": "requires", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnDocument.DocumentRequiresProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype" }, "remarks": "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* .", "stability": "external", "summary": "Specify a target type to define the kinds of resources the document can run on." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1005 }, "name": "targetType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod" }, "remarks": "`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.", "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1012 }, "name": "updateMethod", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname" }, "remarks": "For example, `Release12.1` . This value is unique across all versions of a document, and can't be changed.", "stability": "external", "summary": "An optional field specifying the version of the artifact you are creating with the document." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1019 }, "name": "versionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnDocument" }, "@aws-cdk/aws-ssm.CfnDocument.AttachmentsSourceProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "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.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst attachmentsSourceProperty: ssm.CfnDocument.AttachmentsSourceProperty = {\n key: 'key',\n name: 'name',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnDocument.AttachmentsSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1084 }, "name": "AttachmentsSourceProperty", "namespace": "CfnDocument", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-key" }, "stability": "external", "summary": "The key of a key-value pair that identifies the location of an attachment to a document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1090 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-name" }, "stability": "external", "summary": "The name of the document attachment file." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1096 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html#cfn-ssm-document-attachmentssource-values" }, "remarks": "The format for *Value* depends on the type of key you specify.\n\n- For the key *SourceUrl* , the value is an S3 bucket location. For example:\n\n`\"Values\": [ \"s3://doc-example-bucket/my-folder\" ]`\n- For the key *S3FileUrl* , the value is a file in an S3 bucket. For example:\n\n`\"Values\": [ \"s3://doc-example-bucket/my-folder/my-file.py\" ]`\n- 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:\n\n`\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]`\n\nHowever, 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:\n\n`\"Values\": [ \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\" ]`", "stability": "external", "summary": "The value of a key-value pair that identifies the location of an attachment to a document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1116 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnDocument.AttachmentsSourceProperty" }, "@aws-cdk/aws-ssm.CfnDocument.DocumentRequiresProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "An SSM document required by the current document.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst documentRequiresProperty: ssm.CfnDocument.DocumentRequiresProperty = {\n name: 'name',\n version: 'version',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnDocument.DocumentRequiresProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1183 }, "name": "DocumentRequiresProperty", "namespace": "CfnDocument", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-name" }, "remarks": "The name can be an Amazon Resource Name (ARN).", "stability": "external", "summary": "The name of the required SSM document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1189 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html#cfn-ssm-document-documentrequires-version" }, "stability": "external", "summary": "The document version required by the current document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1195 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnDocument.DocumentRequiresProperty" }, "@aws-cdk/aws-ssm.CfnDocumentProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDocument`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const content: any;\nconst cfnDocumentProps: ssm.CfnDocumentProps = {\n content: content,\n\n // the properties below are optional\n attachments: [{\n key: 'key',\n name: 'name',\n values: ['values'],\n }],\n documentFormat: 'documentFormat',\n documentType: 'documentType',\n name: 'name',\n requires: [{\n name: 'name',\n version: 'version',\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n targetType: 'targetType',\n updateMethod: 'updateMethod',\n versionName: 'versionName',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnDocumentProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 748 }, "name": "CfnDocumentProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content" }, "remarks": "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* .\n\n> This parameter also supports `String` data types.", "stability": "external", "summary": "The content for the new SSM document in JSON or YAML." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 757 }, "name": "content", "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments" }, "stability": "external", "summary": "A list of key-value pairs that describe attachments to a version of a document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 764 }, "name": "attachments", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnDocument.AttachmentsSourceProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat" }, "remarks": "JSON is the default format.", "stability": "external", "summary": "Specify the document format for the request." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 771 }, "name": "documentFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype" }, "remarks": "*Allowed Values* : `ApplicationConfigurationSchema` | `Automation` | `Automation.ChangeTemplate` | `Command` | `DeploymentStrategy` | `Package` | `Policy` | `Session`", "stability": "external", "summary": "The type of document to create." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 780 }, "name": "documentType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name" }, "remarks": "> You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:\n>\n> - `aws`\n> - `amazon`\n> - `amzn`", "stability": "external", "summary": "A name for the SSM document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 793 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires" }, "remarks": "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* .", "stability": "external", "summary": "A list of SSM documents required by a document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 800 }, "name": "requires", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnDocument.DocumentRequiresProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags" }, "remarks": "Use tags to help you identify and categorize resources.", "stability": "external", "summary": "AWS CloudFormation resource tags to apply to the document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 807 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype" }, "remarks": "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* .", "stability": "external", "summary": "Specify a target type to define the kinds of resources the document can run on." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 814 }, "name": "targetType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod" }, "remarks": "`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.", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 821 }, "name": "updateMethod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname" }, "remarks": "For example, `Release12.1` . This value is unique across all versions of a document, and can't be changed.", "stability": "external", "summary": "An optional field specifying the version of the artifact you are creating with the document." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 828 }, "name": "versionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnDocumentProps" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindow": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::MaintenanceWindow", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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.\n\nFor 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* .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::MaintenanceWindow`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnMaintenanceWindow = new ssm.CfnMaintenanceWindow(this, 'MyCfnMaintenanceWindow', {\n allowUnassociatedTargets: false,\n cutoff: 123,\n duration: 123,\n name: 'name',\n schedule: 'schedule',\n\n // the properties below are optional\n description: 'description',\n endDate: 'endDate',\n scheduleOffset: 123,\n scheduleTimezone: 'scheduleTimezone',\n startDate: 'startDate',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindow", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::MaintenanceWindow`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1539 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1430 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1566 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1587 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnMaintenanceWindow", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1434 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1571 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags" }, "remarks": "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.", "stability": "external", "summary": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs)." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1530 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets" }, "remarks": "If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.", "stability": "external", "summary": "Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1460 }, "name": "allowUnassociatedTargets", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff" }, "stability": "external", "summary": "The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1467 }, "name": "cutoff", "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration" }, "stability": "external", "summary": "The duration of the maintenance window in hours." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1474 }, "name": "duration", "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name" }, "stability": "external", "summary": "The name of the maintenance window." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1481 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule" }, "stability": "external", "summary": "The schedule of the maintenance window in the form of a cron or rate expression." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1488 }, "name": "schedule", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description" }, "stability": "external", "summary": "A description of the maintenance window." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1495 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate" }, "stability": "external", "summary": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1502 }, "name": "endDate", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset" }, "stability": "external", "summary": "The number of days to wait to run a maintenance window after the scheduled cron expression date and time." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1509 }, "name": "scheduleOffset", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone" }, "stability": "external", "summary": "The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1516 }, "name": "scheduleTimezone", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate" }, "remarks": "StartDate allows you to delay activation of the Maintenance Window until the specified future date.", "stability": "external", "summary": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1523 }, "name": "startDate", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindow" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnMaintenanceWindow`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnMaintenanceWindowProps: ssm.CfnMaintenanceWindowProps = {\n allowUnassociatedTargets: false,\n cutoff: 123,\n duration: 123,\n name: 'name',\n schedule: 'schedule',\n\n // the properties below are optional\n description: 'description',\n endDate: 'endDate',\n scheduleOffset: 123,\n scheduleTimezone: 'scheduleTimezone',\n startDate: 'startDate',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1258 }, "name": "CfnMaintenanceWindowProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets" }, "remarks": "If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.", "stability": "external", "summary": "Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1265 }, "name": "allowUnassociatedTargets", "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff" }, "stability": "external", "summary": "The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1272 }, "name": "cutoff", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration" }, "stability": "external", "summary": "The duration of the maintenance window in hours." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1279 }, "name": "duration", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name" }, "stability": "external", "summary": "The name of the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1286 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule" }, "stability": "external", "summary": "The schedule of the maintenance window in the form of a cron or rate expression." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1293 }, "name": "schedule", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description" }, "stability": "external", "summary": "A description of the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1300 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate" }, "stability": "external", "summary": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1307 }, "name": "endDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduleoffset" }, "stability": "external", "summary": "The number of days to wait to run a maintenance window after the scheduled cron expression date and time." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1314 }, "name": "scheduleOffset", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone" }, "stability": "external", "summary": "The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1321 }, "name": "scheduleTimezone", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate" }, "remarks": "StartDate allows you to delay activation of the Maintenance Window until the specified future date.", "stability": "external", "summary": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1328 }, "name": "startDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags" }, "remarks": "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.", "stability": "external", "summary": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs)." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1335 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowProps" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::MaintenanceWindowTarget", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::MaintenanceWindowTarget`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnMaintenanceWindowTarget = new ssm.CfnMaintenanceWindowTarget(this, 'MyCfnMaintenanceWindowTarget', {\n resourceType: 'resourceType',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n windowId: 'windowId',\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n ownerInformation: 'ownerInformation',\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::MaintenanceWindowTarget`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1796 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTargetProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1720 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1816 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1832 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnMaintenanceWindowTarget", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1724 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1821 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype" }, "stability": "external", "summary": "The type of target that is being registered with the maintenance window." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1750 }, "name": "resourceType", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets" }, "remarks": "In other words, the instances to run commands on when the maintenance window runs.\n\nYou must specify targets by using the `WindowTargetIds` parameter.", "stability": "external", "summary": "The targets to register with the maintenance window." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1759 }, "name": "targets", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget.TargetsProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid" }, "stability": "external", "summary": "The ID of the maintenance window to register the target with." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1766 }, "name": "windowId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description" }, "stability": "external", "summary": "A description for the target." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1773 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name" }, "stability": "external", "summary": "The name for the maintenance window target." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1780 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation" }, "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1787 }, "name": "ownerInformation", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTarget" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget.TargetsProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`Targets` is a property of the [AWS::SSM::MaintenanceWindowTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html) resource.", "stability": "external", "summary": "The `Targets` property type specifies adding a target to a maintenance window target in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst targetsProperty: ssm.CfnMaintenanceWindowTarget.TargetsProperty = {\n key: 'key',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget.TargetsProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1848 }, "name": "TargetsProperty", "namespace": "CfnMaintenanceWindowTarget", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-key" }, "stability": "external", "summary": "User-defined criteria for sending commands that target managed nodes that meet the criteria." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1854 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtarget-targets.html#cfn-ssm-maintenancewindowtarget-targets-values" }, "remarks": "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` .\n\nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.", "stability": "external", "summary": "User-defined criteria that maps to `Key` ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1862 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTarget.TargetsProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTargetProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnMaintenanceWindowTarget`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnMaintenanceWindowTargetProps: ssm.CfnMaintenanceWindowTargetProps = {\n resourceType: 'resourceType',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n windowId: 'windowId',\n\n // the properties below are optional\n description: 'description',\n name: 'name',\n ownerInformation: 'ownerInformation',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTargetProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1600 }, "name": "CfnMaintenanceWindowTargetProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype" }, "stability": "external", "summary": "The type of target that is being registered with the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1607 }, "name": "resourceType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets" }, "remarks": "In other words, the instances to run commands on when the maintenance window runs.\n\nYou must specify targets by using the `WindowTargetIds` parameter.", "stability": "external", "summary": "The targets to register with the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1616 }, "name": "targets", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTarget.TargetsProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid" }, "stability": "external", "summary": "The ID of the maintenance window to register the target with." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1623 }, "name": "windowId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description" }, "stability": "external", "summary": "A description for the target." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1630 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name" }, "stability": "external", "summary": "The name for the maintenance window target." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1637 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation" }, "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1644 }, "name": "ownerInformation", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTargetProps" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::MaintenanceWindowTask", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::MaintenanceWindowTask`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\ndeclare const taskParameters: any;\nconst cfnMaintenanceWindowTask = new ssm.CfnMaintenanceWindowTask(this, 'MyCfnMaintenanceWindowTask', {\n priority: 123,\n taskArn: 'taskArn',\n taskType: 'taskType',\n windowId: 'windowId',\n\n // the properties below are optional\n cutoffBehavior: 'cutoffBehavior',\n description: 'description',\n loggingInfo: {\n region: 'region',\n s3Bucket: 's3Bucket',\n\n // the properties below are optional\n s3Prefix: 's3Prefix',\n },\n maxConcurrency: 'maxConcurrency',\n maxErrors: 'maxErrors',\n name: 'name',\n serviceRoleArn: 'serviceRoleArn',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n taskInvocationParameters: {\n maintenanceWindowAutomationParameters: {\n documentVersion: 'documentVersion',\n parameters: parameters,\n },\n maintenanceWindowLambdaParameters: {\n clientContext: 'clientContext',\n payload: 'payload',\n qualifier: 'qualifier',\n },\n maintenanceWindowRunCommandParameters: {\n cloudWatchOutputConfig: {\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n cloudWatchOutputEnabled: false,\n },\n comment: 'comment',\n documentHash: 'documentHash',\n documentHashType: 'documentHashType',\n documentVersion: 'documentVersion',\n notificationConfig: {\n notificationArn: 'notificationArn',\n\n // the properties below are optional\n notificationEvents: ['notificationEvents'],\n notificationType: 'notificationType',\n },\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n parameters: parameters,\n serviceRoleArn: 'serviceRoleArn',\n timeoutSeconds: 123,\n },\n maintenanceWindowStepFunctionsParameters: {\n input: 'input',\n name: 'name',\n },\n },\n taskParameters: taskParameters,\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::MaintenanceWindowTask`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2302 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTaskProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2149 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2331 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2355 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnMaintenanceWindowTask", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2153 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2336 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority" }, "remarks": "The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.", "stability": "external", "summary": "The priority of the task in the maintenance window." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2179 }, "name": "priority", "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn" }, "remarks": "For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the SSM document name or Amazon Resource Name (ARN).\n\nFor `LAMBDA` tasks, `TaskArn` is the function name or ARN.\n\nFor `STEP_FUNCTIONS` tasks, `TaskArn` is the state machine ARN.", "stability": "external", "summary": "The resource that the task uses during execution." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2192 }, "name": "taskArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters" }, "remarks": "> `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html) .", "stability": "external", "summary": "The parameters to pass to the task when it runs." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2293 }, "name": "taskParameters", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype" }, "remarks": "Valid values: `RUN_COMMAND` , `AUTOMATION` , `LAMBDA` , `STEP_FUNCTIONS` .", "stability": "external", "summary": "The type of task." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2199 }, "name": "taskType", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid" }, "stability": "external", "summary": "The ID of the maintenance window where the task is registered." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2206 }, "name": "windowId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior" }, "stability": "external", "summary": "The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2213 }, "name": "cutoffBehavior", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description" }, "stability": "external", "summary": "A description of the task." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2220 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo" }, "remarks": "> `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .", "stability": "external", "summary": "Information about an Amazon S3 bucket to write Run Command task-level logs to." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2229 }, "name": "loggingInfo", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.LoggingInfoProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency" }, "remarks": "> Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.\n>\n> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1` . This value doesn't affect the running of your task.", "stability": "external", "summary": "The maximum number of targets this task can be run for, in parallel." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2240 }, "name": "maxConcurrency", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors" }, "remarks": "> Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.\n>\n> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1` . This value doesn't affect the running of your task.", "stability": "external", "summary": "The maximum number of errors allowed before this task stops being scheduled." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2251 }, "name": "maxErrors", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name" }, "stability": "external", "summary": "The task name." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2258 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2265 }, "name": "serviceRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets" }, "remarks": "- Specify instances using `Key=InstanceIds,Values= *instanceid1* , *instanceid2*` .\n- Specify window target IDs using `Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*` .", "stability": "external", "summary": "The targets, either instances or window target IDs." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2275 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TargetProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters" }, "remarks": "Populate only the fields that match the task type. All other fields should be empty.\n\n> When you update a maintenance window task that has options specified in `TaskInvocationParameters` , you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified `TaskInvocationParameters` values for `Comment` , `NotificationConfig` , and `OutputS3BucketName` . If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.", "stability": "external", "summary": "The parameters to pass to the task when it runs." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2284 }, "name": "taskInvocationParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty" } ] } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Configuration options for sending command output to Amazon CloudWatch Logs.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cloudWatchOutputConfigProperty: ssm.CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty = {\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n cloudWatchOutputEnabled: false,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2369 }, "name": "CloudWatchOutputConfigProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchloggroupname" }, "remarks": "If you don't specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format:\n\n`aws/ssm/ *SystemsManagerDocumentName*`", "stability": "external", "summary": "The name of the CloudWatch Logs log group where you want to send command output." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2377 }, "name": "cloudWatchLogGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchoutputenabled" }, "stability": "external", "summary": "Enables Systems Manager to send command output to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2383 }, "name": "cloudWatchOutputEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.LoggingInfoProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`LoggingInfo` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) resource.\n\n> `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .", "stability": "external", "summary": "The `LoggingInfo` property type specifies information about the Amazon S3 bucket to write instance-level logs to.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst loggingInfoProperty: ssm.CfnMaintenanceWindowTask.LoggingInfoProperty = {\n region: 'region',\n s3Bucket: 's3Bucket',\n\n // the properties below are optional\n s3Prefix: 's3Prefix',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.LoggingInfoProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2451 }, "name": "LoggingInfoProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region" }, "stability": "external", "summary": "The AWS Region where the S3 bucket is located." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2457 }, "name": "region", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket" }, "stability": "external", "summary": "The name of an S3 bucket where execution logs are stored." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2463 }, "name": "s3Bucket", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix" }, "stability": "external", "summary": "The Amazon S3 bucket subfolder." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2469 }, "name": "s3Prefix", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.LoggingInfoProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`MaintenanceWindowAutomationParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.\n\nFor information about available parameters in Automation runbooks, you can view the content of the runbook itself in the Systems Manager console. For information, see [View runbook content](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents-reference-details.html#view-automation-json) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "The `MaintenanceWindowAutomationParameters` property type specifies the parameters for an `AUTOMATION` task type for a maintenance window task in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\nconst maintenanceWindowAutomationParametersProperty: ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty = {\n documentVersion: 'documentVersion',\n parameters: parameters,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2542 }, "name": "MaintenanceWindowAutomationParametersProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion" }, "stability": "external", "summary": "The version of an Automation runbook to use during task execution." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2548 }, "name": "documentVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters" }, "stability": "external", "summary": "The parameters for the AUTOMATION task." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2554 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`MaintenanceWindowLambdaParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.", "stability": "external", "summary": "The `MaintenanceWindowLambdaParameters` property type specifies the parameters for a `LAMBDA` task type for a maintenance window task in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst maintenanceWindowLambdaParametersProperty: ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty = {\n clientContext: 'clientContext',\n payload: 'payload',\n qualifier: 'qualifier',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2620 }, "name": "MaintenanceWindowLambdaParametersProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext" }, "remarks": "You can then use the `context` variable to process the client information in your AWS Lambda function.", "stability": "external", "summary": "Client-specific information to pass to the AWS Lambda function that you're invoking." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2626 }, "name": "clientContext", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload" }, "remarks": "> Although `Type` is listed as \"String\" for this property, the payload content must be formatted as a Base64-encoded binary data object.\n\n*Length Constraint:* 4096", "stability": "external", "summary": "JSON to provide to your AWS Lambda function as input." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2636 }, "name": "payload", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier" }, "remarks": "If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.", "stability": "external", "summary": "An AWS Lambda function version or alias name." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2642 }, "name": "qualifier", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This means that these parameters are the same as those for the `SendCommand` API call. For more information about `SendCommand` parameters, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) in the *AWS Systems Manager API Reference* .\n\nFor information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see [Viewing SSM command document content](https://docs.aws.amazon.com/systems-manager/latest/userguide/viewing-ssm-document-content.html) in the *AWS Systems Manager User Guide* .\n\n`MaintenanceWindowRunCommandParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.", "stability": "external", "summary": "The `MaintenanceWindowRunCommandParameters` property type specifies the parameters for a `RUN_COMMAND` task type for a maintenance window task in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\nconst maintenanceWindowRunCommandParametersProperty: ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty = {\n cloudWatchOutputConfig: {\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n cloudWatchOutputEnabled: false,\n },\n comment: 'comment',\n documentHash: 'documentHash',\n documentHashType: 'documentHashType',\n documentVersion: 'documentVersion',\n notificationConfig: {\n notificationArn: 'notificationArn',\n\n // the properties below are optional\n notificationEvents: ['notificationEvents'],\n notificationType: 'notificationType',\n },\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n parameters: parameters,\n serviceRoleArn: 'serviceRoleArn',\n timeoutSeconds: 123,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2713 }, "name": "MaintenanceWindowRunCommandParametersProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig" }, "stability": "external", "summary": "Configuration options for sending command output to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2719 }, "name": "cloudWatchOutputConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment" }, "stability": "external", "summary": "Information about the command or commands to run." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2725 }, "name": "comment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash" }, "remarks": "SHA-1 hashes have been deprecated.", "stability": "external", "summary": "The SHA-256 or SHA-1 hash created by the system when the document was created." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2731 }, "name": "documentHash", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype" }, "remarks": "SHA-1 hashes are deprecated.", "stability": "external", "summary": "The SHA-256 or SHA-1 hash type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2737 }, "name": "documentHashType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion" }, "remarks": "You can specify `$DEFAULT` , `$LATEST` , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:\n\n`--document-version \"\\$DEFAULT\"`\n\n`--document-version \"\\$LATEST\"`\n\n`--document-version \"3\"`", "stability": "external", "summary": "The AWS Systems Manager document (SSM document) version to use in the request." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2749 }, "name": "documentVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig" }, "stability": "external", "summary": "Configurations for sending notifications about command status changes on a per-managed node basis." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2755 }, "name": "notificationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.NotificationConfigProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname" }, "stability": "external", "summary": "The name of the Amazon Simple Storage Service (Amazon S3) bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2761 }, "name": "outputS3BucketName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix" }, "stability": "external", "summary": "The S3 bucket subfolder." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2767 }, "name": "outputS3KeyPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters" }, "remarks": "The supported parameters are the same as those for the `SendCommand` API call. For more information, see [SendCommand](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_SendCommand.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "The parameters for the `RUN_COMMAND` task execution." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2775 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2781 }, "name": "serviceRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds" }, "stability": "external", "summary": "If this time is reached and the command hasn't already started running, it doesn't run." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2787 }, "name": "timeoutSeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`MaintenanceWindowStepFunctionsParameters` is a property of the [TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html) property type.", "stability": "external", "summary": "The `MaintenanceWindowStepFunctionsParameters` property type specifies the parameters for the execution of a `STEP_FUNCTIONS` task in a Systems Manager maintenance window.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst maintenanceWindowStepFunctionsParametersProperty: ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty = {\n input: 'input',\n name: 'name',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2880 }, "name": "MaintenanceWindowStepFunctionsParametersProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input" }, "stability": "external", "summary": "The inputs for the `STEP_FUNCTIONS` task." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2886 }, "name": "input", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name" }, "stability": "external", "summary": "The name of the `STEP_FUNCTIONS` task." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2892 }, "name": "name", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.NotificationConfigProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`NotificationConfig` is a property of the [MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) property type.", "stability": "external", "summary": "The `NotificationConfig` property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst notificationConfigProperty: ssm.CfnMaintenanceWindowTask.NotificationConfigProperty = {\n notificationArn: 'notificationArn',\n\n // the properties below are optional\n notificationEvents: ['notificationEvents'],\n notificationType: 'notificationType',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.NotificationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2958 }, "name": "NotificationConfigProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn" }, "remarks": "Run Command pushes notifications about command status changes to this topic.", "stability": "external", "summary": "An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2964 }, "name": "notificationArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents" }, "remarks": "These events include the following: `All` (events), `InProgress` , `Success` , `TimedOut` , `Cancelled` , `Failed` . To learn more about these events, see [Configuring Amazon SNS Notifications for AWS Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "The different events that you can receive notifications for." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2970 }, "name": "notificationEvents", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype" }, "remarks": "- `Command` : Receive notification when the status of a command changes.\n- `Invocation` : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.", "stability": "external", "summary": "The notification type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2979 }, "name": "notificationType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.NotificationConfigProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TargetProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You specify instances by using `Key=InstanceIds,Values=< *instanceid1* >,< *instanceid2* >` . You specify window target IDs using `Key=WindowTargetIds,Values=< *window-target-id-1* >,< *window-target-id-2* >` for a maintenance window task in AWS Systems Manager .\n\n`Target` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.\n\n> To use `resource-groups:Name` as the key for a maintenance window target, specify the resource group as a `AWS::SSM::MaintenanceWindowTarget` type, and use the `Ref` function to specify the target for `AWS::SSM::MaintenanceWindowTask` . For an example, see *Create a Run Command task that targets instances using a resource group name* in [AWS::SSM::MaintenanceWindowTask Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#aws-resource-ssm-maintenancewindowtask--examples) .", "stability": "external", "summary": "The `Target` property type specifies targets (either instances or window target IDs).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst targetProperty: ssm.CfnMaintenanceWindowTask.TargetProperty = {\n key: 'key',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TargetProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3051 }, "name": "TargetProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key" }, "remarks": "`Key` can be `InstanceIds` or `WindowTargetIds` . For more information about how to target instances within a maintenance window task, see [About 'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "User-defined criteria for sending commands that target instances that meet the criteria." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3057 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values" }, "remarks": "For example, if you specify `InstanceIds` , you can specify `i-1234567890abcdef0,i-9876543210abcdef0` to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see [About 'register-task-with-maintenance-window' Options and Values](https://docs.aws.amazon.com/systems-manager/latest/userguide/register-tasks-options.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "User-defined criteria that maps to `Key` ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3063 }, "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.TargetProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`TaskInvocationParameters` is a property of the [AWS::SSM::MaintenanceWindowTask](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html) property type.", "stability": "external", "summary": "The `TaskInvocationParameters` property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\nconst taskInvocationParametersProperty: ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty = {\n maintenanceWindowAutomationParameters: {\n documentVersion: 'documentVersion',\n parameters: parameters,\n },\n maintenanceWindowLambdaParameters: {\n clientContext: 'clientContext',\n payload: 'payload',\n qualifier: 'qualifier',\n },\n maintenanceWindowRunCommandParameters: {\n cloudWatchOutputConfig: {\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n cloudWatchOutputEnabled: false,\n },\n comment: 'comment',\n documentHash: 'documentHash',\n documentHashType: 'documentHashType',\n documentVersion: 'documentVersion',\n notificationConfig: {\n notificationArn: 'notificationArn',\n\n // the properties below are optional\n notificationEvents: ['notificationEvents'],\n notificationType: 'notificationType',\n },\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n parameters: parameters,\n serviceRoleArn: 'serviceRoleArn',\n timeoutSeconds: 123,\n },\n maintenanceWindowStepFunctionsParameters: {\n input: 'input',\n name: 'name',\n },\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3131 }, "name": "TaskInvocationParametersProperty", "namespace": "CfnMaintenanceWindowTask", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters" }, "stability": "external", "summary": "The parameters for an `AUTOMATION` task type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3137 }, "name": "maintenanceWindowAutomationParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters" }, "stability": "external", "summary": "The parameters for a `LAMBDA` task type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3143 }, "name": "maintenanceWindowLambdaParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters" }, "stability": "external", "summary": "The parameters for a `RUN_COMMAND` task type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3149 }, "name": "maintenanceWindowRunCommandParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters" }, "stability": "external", "summary": "The parameters for a `STEP_FUNCTIONS` task type." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3155 }, "name": "maintenanceWindowStepFunctionsParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty" } ] } } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTask.TaskInvocationParametersProperty" }, "@aws-cdk/aws-ssm.CfnMaintenanceWindowTaskProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnMaintenanceWindowTask`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const parameters: any;\ndeclare const taskParameters: any;\nconst cfnMaintenanceWindowTaskProps: ssm.CfnMaintenanceWindowTaskProps = {\n priority: 123,\n taskArn: 'taskArn',\n taskType: 'taskType',\n windowId: 'windowId',\n\n // the properties below are optional\n cutoffBehavior: 'cutoffBehavior',\n description: 'description',\n loggingInfo: {\n region: 'region',\n s3Bucket: 's3Bucket',\n\n // the properties below are optional\n s3Prefix: 's3Prefix',\n },\n maxConcurrency: 'maxConcurrency',\n maxErrors: 'maxErrors',\n name: 'name',\n serviceRoleArn: 'serviceRoleArn',\n targets: [{\n key: 'key',\n values: ['values'],\n }],\n taskInvocationParameters: {\n maintenanceWindowAutomationParameters: {\n documentVersion: 'documentVersion',\n parameters: parameters,\n },\n maintenanceWindowLambdaParameters: {\n clientContext: 'clientContext',\n payload: 'payload',\n qualifier: 'qualifier',\n },\n maintenanceWindowRunCommandParameters: {\n cloudWatchOutputConfig: {\n cloudWatchLogGroupName: 'cloudWatchLogGroupName',\n cloudWatchOutputEnabled: false,\n },\n comment: 'comment',\n documentHash: 'documentHash',\n documentHashType: 'documentHashType',\n documentVersion: 'documentVersion',\n notificationConfig: {\n notificationArn: 'notificationArn',\n\n // the properties below are optional\n notificationEvents: ['notificationEvents'],\n notificationType: 'notificationType',\n },\n outputS3BucketName: 'outputS3BucketName',\n outputS3KeyPrefix: 'outputS3KeyPrefix',\n parameters: parameters,\n serviceRoleArn: 'serviceRoleArn',\n timeoutSeconds: 123,\n },\n maintenanceWindowStepFunctionsParameters: {\n input: 'input',\n name: 'name',\n },\n },\n taskParameters: taskParameters,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTaskProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1927 }, "name": "CfnMaintenanceWindowTaskProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority" }, "remarks": "The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.", "stability": "external", "summary": "The priority of the task in the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1934 }, "name": "priority", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn" }, "remarks": "For `RUN_COMMAND` and `AUTOMATION` task types, `TaskArn` is the SSM document name or Amazon Resource Name (ARN).\n\nFor `LAMBDA` tasks, `TaskArn` is the function name or ARN.\n\nFor `STEP_FUNCTIONS` tasks, `TaskArn` is the state machine ARN.", "stability": "external", "summary": "The resource that the task uses during execution." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1947 }, "name": "taskArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype" }, "remarks": "Valid values: `RUN_COMMAND` , `AUTOMATION` , `LAMBDA` , `STEP_FUNCTIONS` .", "stability": "external", "summary": "The type of task." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1954 }, "name": "taskType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid" }, "stability": "external", "summary": "The ID of the maintenance window where the task is registered." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1961 }, "name": "windowId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior" }, "stability": "external", "summary": "The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1968 }, "name": "cutoffBehavior", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description" }, "stability": "external", "summary": "A description of the task." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1975 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo" }, "remarks": "> `LoggingInfo` has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html) .", "stability": "external", "summary": "Information about an Amazon S3 bucket to write Run Command task-level logs to." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1984 }, "name": "loggingInfo", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.LoggingInfoProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency" }, "remarks": "> Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.\n>\n> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1` . This value doesn't affect the running of your task.", "stability": "external", "summary": "The maximum number of targets this task can be run for, in parallel." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 1995 }, "name": "maxConcurrency", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors" }, "remarks": "> Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases.\n>\n> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1` . This value doesn't affect the running of your task.", "stability": "external", "summary": "The maximum number of errors allowed before this task stops being scheduled." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2006 }, "name": "maxErrors", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name" }, "stability": "external", "summary": "The task name." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2013 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2020 }, "name": "serviceRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets" }, "remarks": "- Specify instances using `Key=InstanceIds,Values= *instanceid1* , *instanceid2*` .\n- Specify window target IDs using `Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2*` .", "stability": "external", "summary": "The targets, either instances or window target IDs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2030 }, "name": "targets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TargetProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters" }, "remarks": "Populate only the fields that match the task type. All other fields should be empty.\n\n> When you update a maintenance window task that has options specified in `TaskInvocationParameters` , you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified `TaskInvocationParameters` values for `Comment` , `NotificationConfig` , and `OutputS3BucketName` . If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.", "stability": "external", "summary": "The parameters to pass to the task when it runs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2039 }, "name": "taskInvocationParameters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters" }, "remarks": "> `TaskParameters` has been deprecated. To specify parameters to pass to a task when it runs, instead use the `Parameters` option in the `TaskInvocationParameters` structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see [MaintenanceWindowTaskInvocationParameters](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_MaintenanceWindowTaskInvocationParameters.html) .", "stability": "external", "summary": "The parameters to pass to the task when it runs." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 2048 }, "name": "taskParameters", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "lib/ssm.generated:CfnMaintenanceWindowTaskProps" }, "@aws-cdk/aws-ssm.CfnParameter": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::Parameter", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::SSM::Parameter` resource creates an SSM parameter in AWS Systems Manager Parameter Store.\n\n> To create an SSM parameter, you must have the AWS Identity and Access Management ( IAM ) permissions `ssm:PutParameter` and `ssm:AddTagsToResource` . On stack creation, AWS CloudFormation adds the following three tags to the parameter: `aws:cloudformation:stack-name` , `aws:cloudformation:logical-id` , and `aws:cloudformation:stack-id` , in addition to any custom tags you specify.\n>\n> To add, update, or remove tags during stack update, you must have IAM permissions for both `ssm:AddTagsToResource` and `ssm:RemoveTagsFromResource` . For more information, see [Managing Access Using Policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/security-iam.html#security_iam_access-manage) in the *AWS Systems Manager User Guide* .\n\nFor information about valid values for parameters, see [Requirements and Constraints for Parameter Names](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html#sysman-parameter-name-constraints) in the *AWS Systems Manager User Guide* and [PutParameter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::Parameter`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const tags: any;\nconst cfnParameter = new ssm.CfnParameter(this, 'MyCfnParameter', {\n type: 'type',\n value: 'value',\n\n // the properties below are optional\n allowedPattern: 'allowedPattern',\n dataType: 'dataType',\n description: 'description',\n name: 'name',\n policies: 'policies',\n tags: tags,\n tier: 'tier',\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnParameter", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::Parameter`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3504 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnParameterProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3387 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3528 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3547 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnParameter", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3391 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Type" }, "remarks": "Valid values are `String` or `StringList` .", "stability": "external", "summary": "Returns the type of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3416 }, "name": "attrType", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Value" }, "stability": "external", "summary": "Returns the value of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3422 }, "name": "attrValue", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3533 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags" }, "remarks": "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 Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.", "stability": "external", "summary": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs)." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3488 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type" }, "remarks": "> AWS CloudFormation doesn't support creating a `SecureString` parameter type.\n\n*Allowed Values* : String | StringList", "stability": "external", "summary": "The type of parameter." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3433 }, "name": "type", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value" }, "remarks": "> If type is `StringList` , the system returns a comma-separated string with no spaces between commas in the `Value` field.", "stability": "external", "summary": "The parameter value." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3442 }, "name": "value", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern" }, "remarks": "For example, for String types with values restricted to numbers, you can specify the following: `AllowedPattern=^\\d+$`", "stability": "external", "summary": "A regular expression used to validate the parameter value." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3449 }, "name": "allowedPattern", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype" }, "remarks": "The default is `text` .", "stability": "external", "summary": "The data type of the parameter, such as `text` or `aws:ec2:image` ." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3456 }, "name": "dataType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description" }, "stability": "external", "summary": "Information about the parameter." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3463 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name" }, "remarks": "> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: `arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName`", "stability": "external", "summary": "The name of the parameter." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3472 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies" }, "remarks": "[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "Information about the policies assigned to a parameter." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3481 }, "name": "policies", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier" }, "stability": "external", "summary": "The parameter tier." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3495 }, "name": "tier", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnParameter" }, "@aws-cdk/aws-ssm.CfnParameterProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnParameter`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const tags: any;\nconst cfnParameterProps: ssm.CfnParameterProps = {\n type: 'type',\n value: 'value',\n\n // the properties below are optional\n allowedPattern: 'allowedPattern',\n dataType: 'dataType',\n description: 'description',\n name: 'name',\n policies: 'policies',\n tags: tags,\n tier: 'tier',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnParameterProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3224 }, "name": "CfnParameterProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type" }, "remarks": "> AWS CloudFormation doesn't support creating a `SecureString` parameter type.\n\n*Allowed Values* : String | StringList", "stability": "external", "summary": "The type of parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3235 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value" }, "remarks": "> If type is `StringList` , the system returns a comma-separated string with no spaces between commas in the `Value` field.", "stability": "external", "summary": "The parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3244 }, "name": "value", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern" }, "remarks": "For example, for String types with values restricted to numbers, you can specify the following: `AllowedPattern=^\\d+$`", "stability": "external", "summary": "A regular expression used to validate the parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3251 }, "name": "allowedPattern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype" }, "remarks": "The default is `text` .", "stability": "external", "summary": "The data type of the parameter, such as `text` or `aws:ec2:image` ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3258 }, "name": "dataType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description" }, "stability": "external", "summary": "Information about the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3265 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name" }, "remarks": "> The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: `arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName`", "stability": "external", "summary": "The name of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3274 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies" }, "remarks": "[Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "Information about the policies assigned to a parameter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3283 }, "name": "policies", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags" }, "remarks": "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 Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.", "stability": "external", "summary": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs)." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3290 }, "name": "tags", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier" }, "stability": "external", "summary": "The parameter tier." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3297 }, "name": "tier", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnParameterProps" }, "@aws-cdk/aws-ssm.CfnPatchBaseline": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::PatchBaseline", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::SSM::PatchBaseline` resource defines the basic information for an AWS Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances.\n\nFor more information, see [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::PatchBaseline`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnPatchBaseline = new ssm.CfnPatchBaseline(this, 'MyCfnPatchBaseline', {\n name: 'name',\n\n // the properties below are optional\n approvalRules: {\n patchRules: [{\n approveAfterDays: 123,\n approveUntilDate: 'approveUntilDate',\n complianceLevel: 'complianceLevel',\n enableNonSecurity: false,\n patchFilterGroup: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n }],\n },\n approvedPatches: ['approvedPatches'],\n approvedPatchesComplianceLevel: 'approvedPatchesComplianceLevel',\n approvedPatchesEnableNonSecurity: false,\n description: 'description',\n globalFilters: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n operatingSystem: 'operatingSystem',\n patchGroups: ['patchGroups'],\n rejectedPatches: ['rejectedPatches'],\n rejectedPatchesAction: 'rejectedPatchesAction',\n sources: [{\n configuration: 'configuration',\n name: 'name',\n products: ['products'],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::PatchBaseline`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3885 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaselineProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3755 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3910 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3933 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnPatchBaseline", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3759 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3915 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags" }, "remarks": "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 patch baseline to identify the severity level of patches it specifies and the operating system family it applies to.", "stability": "external", "summary": "Optional metadata that you assign to a resource." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3876 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name" }, "stability": "external", "summary": "The name of the patch baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3785 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules" }, "stability": "external", "summary": "A set of rules used to include patches in the baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3792 }, "name": "approvalRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleGroupProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches" }, "remarks": "For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "A list of explicitly approved patches for the baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3801 }, "name": "approvedPatches", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel" }, "remarks": "When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is `UNSPECIFIED` .", "stability": "external", "summary": "Defines the compliance level for approved patches." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3808 }, "name": "approvedPatchesComplianceLevel", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity" }, "remarks": "The default value is `false` . Applies to Linux managed nodes only.", "stability": "external", "summary": "Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3815 }, "name": "approvedPatchesEnableNonSecurity", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description" }, "stability": "external", "summary": "A description of the patch baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3822 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters" }, "stability": "external", "summary": "A set of global filters used to include patches in the baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3829 }, "name": "globalFilters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterGroupProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem" }, "remarks": "The default value is `WINDOWS` .", "stability": "external", "summary": "Defines the operating system the patch baseline applies to." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3836 }, "name": "operatingSystem", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups" }, "stability": "external", "summary": "The name of the patch group to be registered with the patch baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3843 }, "name": "patchGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches" }, "remarks": "For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "A list of explicitly rejected patches for the baseline." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3852 }, "name": "rejectedPatches", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction" }, "remarks": "- *`ALLOW_AS_DEPENDENCY`* : A package in the `Rejected` patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as `InstalledOther` . This is the default action if no option is specified.\n- *`BLOCK`* : Packages in the `RejectedPatches` list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as `InstalledRejected` .", "stability": "external", "summary": "The action for Patch Manager to take on patches included in the `RejectedPackages` list." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3862 }, "name": "rejectedPatchesAction", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources" }, "remarks": "Applies to Linux managed nodes only.", "stability": "external", "summary": "Information about the patches to use to update the managed nodes, including target operating systems and source repositories." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3869 }, "name": "sources", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchSourceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline" }, "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterGroupProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`PatchFilterGroup` is the property type for the `GlobalFilters` property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource and the `PatchFilterGroup` property of the [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html) property type.", "stability": "external", "summary": "The `PatchFilterGroup` property type specifies a set of patch filters for an AWS Systems Manager patch baseline, typically used for approval rules for a Systems Manager patch baseline.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst patchFilterGroupProperty: ssm.CfnPatchBaseline.PatchFilterGroupProperty = {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterGroupProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4033 }, "name": "PatchFilterGroupProperty", "namespace": "CfnPatchBaseline", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters" }, "stability": "external", "summary": "The set of patch filters that make up the group." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4039 }, "name": "patchFilters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline.PatchFilterGroupProperty" }, "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `PatchFilters` property of the [PatchFilterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html) property type contains a list of `PatchFilter` property types.\n\nYou can view lists of valid values for the patch properties by running the `DescribePatchProperties` command. For more information, see [DescribePatchProperties](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribePatchProperties.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "The `PatchFilter` property type defines a patch filter for an AWS Systems Manager patch baseline.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst patchFilterProperty: ssm.CfnPatchBaseline.PatchFilterProperty = {\n key: 'key',\n values: ['values'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3951 }, "name": "PatchFilterProperty", "namespace": "CfnPatchBaseline", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key" }, "remarks": "For information about valid keys, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "The key for the filter." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3959 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values" }, "remarks": "For information about valid values for each key based on operating system type, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* .", "stability": "external", "summary": "The value for the filter key." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3967 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline.PatchFilterProperty" }, "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchSourceProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The AWS CloudFormation `AWS::SSM::PatchSource` resource is used to provide information about the patches to use to update target instances, including target operating systems and source repository. Applies to Linux instances only.", "stability": "external", "summary": "`PatchSource` is the property type for the `Sources` resource of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst patchSourceProperty: ssm.CfnPatchBaseline.PatchSourceProperty = {\n configuration: 'configuration',\n name: 'name',\n products: ['products'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4102 }, "name": "PatchSourceProperty", "namespace": "CfnPatchBaseline", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration" }, "remarks": "`[main]`\n\n`name=MyCustomRepository`\n\n`baseurl=https://my-custom-repository`\n\n`enabled=1`\n\n> For information about other options available for your yum repository configuration, see [dnf.conf(5)](https://docs.aws.amazon.com/https://man7.org/linux/man-pages/man5/dnf.conf.5.html) .", "stability": "external", "summary": "The value of the yum repo configuration. For example:." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4118 }, "name": "configuration", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name" }, "stability": "external", "summary": "The name specified to identify the patch source." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4124 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products" }, "stability": "external", "summary": "The specific operating system versions a patch repository applies to, such as \"Ubuntu16.04\", \"AmazonLinux2016.09\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product values, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference* ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4130 }, "name": "products", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline.PatchSourceProperty" }, "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleGroupProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "`RuleGroup` is the property type for the `ApprovalRules` property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource.", "stability": "external", "summary": "The `RuleGroup` property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst ruleGroupProperty: ssm.CfnPatchBaseline.RuleGroupProperty = {\n patchRules: [{\n approveAfterDays: 123,\n approveUntilDate: 'approveUntilDate',\n complianceLevel: 'complianceLevel',\n enableNonSecurity: false,\n patchFilterGroup: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n }],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleGroupProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4310 }, "name": "RuleGroupProperty", "namespace": "CfnPatchBaseline", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules" }, "stability": "external", "summary": "The rules that make up the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4316 }, "name": "patchRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline.RuleGroupProperty" }, "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `PatchRules` property of the [RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html) property type contains a list of `Rule` property types.", "stability": "external", "summary": "The `Rule` property type specifies an approval rule for a Systems Manager patch baseline.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst ruleProperty: ssm.CfnPatchBaseline.RuleProperty = {\n approveAfterDays: 123,\n approveUntilDate: 'approveUntilDate',\n complianceLevel: 'complianceLevel',\n enableNonSecurity: false,\n patchFilterGroup: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4199 }, "name": "RuleProperty", "namespace": "CfnPatchBaseline", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays" }, "remarks": "For example, a value of `7` means that patches are approved seven days after they are released.\n\nYou must specify a value for `ApproveAfterDays` .\n\nException: Not supported on Debian Server or Ubuntu Server.", "stability": "external", "summary": "The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4209 }, "name": "approveAfterDays", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveuntildate" }, "remarks": "Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.\n\nEnter dates in the format `YYYY-MM-DD` . For example, `2021-12-31` .", "stability": "external", "summary": "The cutoff date for auto approval of released patches." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4217 }, "name": "approveUntilDate", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel" }, "remarks": "Valid compliance severity levels include the following: `UNSPECIFIED` , `CRITICAL` , `HIGH` , `MEDIUM` , `LOW` , and `INFORMATIONAL` .", "stability": "external", "summary": "A compliance severity level for all approved patches in a patch baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4223 }, "name": "complianceLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity" }, "remarks": "The default value is `false` . Applies to Linux managed nodes only.", "stability": "external", "summary": "For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4229 }, "name": "enableNonSecurity", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup" }, "stability": "external", "summary": "The patch filter group that defines the criteria for the rule." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4235 }, "name": "patchFilterGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterGroupProperty" } ] } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaseline.RuleProperty" }, "@aws-cdk/aws-ssm.CfnPatchBaselineProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnPatchBaseline`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnPatchBaselineProps: ssm.CfnPatchBaselineProps = {\n name: 'name',\n\n // the properties below are optional\n approvalRules: {\n patchRules: [{\n approveAfterDays: 123,\n approveUntilDate: 'approveUntilDate',\n complianceLevel: 'complianceLevel',\n enableNonSecurity: false,\n patchFilterGroup: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n }],\n },\n approvedPatches: ['approvedPatches'],\n approvedPatchesComplianceLevel: 'approvedPatchesComplianceLevel',\n approvedPatchesEnableNonSecurity: false,\n description: 'description',\n globalFilters: {\n patchFilters: [{\n key: 'key',\n values: ['values'],\n }],\n },\n operatingSystem: 'operatingSystem',\n patchGroups: ['patchGroups'],\n rejectedPatches: ['rejectedPatches'],\n rejectedPatchesAction: 'rejectedPatchesAction',\n sources: [{\n configuration: 'configuration',\n name: 'name',\n products: ['products'],\n }],\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnPatchBaselineProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3560 }, "name": "CfnPatchBaselineProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name" }, "stability": "external", "summary": "The name of the patch baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3567 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules" }, "stability": "external", "summary": "A set of rules used to include patches in the baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3574 }, "name": "approvalRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.RuleGroupProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches" }, "remarks": "For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "A list of explicitly approved patches for the baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3583 }, "name": "approvedPatches", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel" }, "remarks": "When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is `UNSPECIFIED` .", "stability": "external", "summary": "Defines the compliance level for approved patches." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3590 }, "name": "approvedPatchesComplianceLevel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity" }, "remarks": "The default value is `false` . Applies to Linux managed nodes only.", "stability": "external", "summary": "Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3597 }, "name": "approvedPatchesEnableNonSecurity", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description" }, "stability": "external", "summary": "A description of the patch baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3604 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters" }, "stability": "external", "summary": "A set of global filters used to include patches in the baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3611 }, "name": "globalFilters", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchFilterGroupProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem" }, "remarks": "The default value is `WINDOWS` .", "stability": "external", "summary": "Defines the operating system the patch baseline applies to." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3618 }, "name": "operatingSystem", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups" }, "stability": "external", "summary": "The name of the patch group to be registered with the patch baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3625 }, "name": "patchGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches" }, "remarks": "For information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide* .", "stability": "external", "summary": "A list of explicitly rejected patches for the baseline." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3634 }, "name": "rejectedPatches", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction" }, "remarks": "- *`ALLOW_AS_DEPENDENCY`* : A package in the `Rejected` patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as `InstalledOther` . This is the default action if no option is specified.\n- *`BLOCK`* : Packages in the `RejectedPatches` list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as `InstalledRejected` .", "stability": "external", "summary": "The action for Patch Manager to take on patches included in the `RejectedPackages` list." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3644 }, "name": "rejectedPatchesAction", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources" }, "remarks": "Applies to Linux managed nodes only.", "stability": "external", "summary": "Information about the patches to use to update the managed nodes, including target operating systems and source repositories." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3651 }, "name": "sources", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnPatchBaseline.PatchSourceProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags" }, "remarks": "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 patch baseline to identify the severity level of patches it specifies and the operating system family it applies to.", "stability": "external", "summary": "Optional metadata that you assign to a resource." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 3658 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnPatchBaselineProps" }, "@aws-cdk/aws-ssm.CfnResourceDataSync": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::ResourceDataSync", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::SSM::ResourceDataSync` resource creates, updates, or deletes a resource data sync for AWS Systems Manager . A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: `SyncToDestination` and `SyncFromSource` .\n\nYou can configure Systems Manager Inventory to use the `SyncToDestination` type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket.\n\nYou can configure Systems Manager Explorer to use the `SyncFromSource` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an `EntireOrganization` by using AWS Organizations .\n\nA resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.\n\nBy default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.\n\nFor more information, see [Configuring Inventory Collection](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync) and [Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the *AWS Systems Manager User Guide* .\n\nImportant: The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Please see the *Examples* section when you create your resource data sync.", "stability": "external", "summary": "A CloudFormation `AWS::SSM::ResourceDataSync`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnResourceDataSync = new ssm.CfnResourceDataSync(this, 'MyCfnResourceDataSync', {\n syncName: 'syncName',\n\n // the properties below are optional\n bucketName: 'bucketName',\n bucketPrefix: 'bucketPrefix',\n bucketRegion: 'bucketRegion',\n kmsKeyArn: 'kmsKeyArn',\n s3Destination: {\n bucketName: 'bucketName',\n bucketRegion: 'bucketRegion',\n syncFormat: 'syncFormat',\n\n // the properties below are optional\n bucketPrefix: 'bucketPrefix',\n kmsKeyArn: 'kmsKeyArn',\n },\n syncFormat: 'syncFormat',\n syncSource: {\n sourceRegions: ['sourceRegions'],\n sourceType: 'sourceType',\n\n // the properties below are optional\n awsOrganizationsSource: {\n organizationSourceType: 'organizationSourceType',\n\n // the properties below are optional\n organizationalUnits: ['organizationalUnits'],\n },\n includeFutureRegions: false,\n },\n syncType: 'syncType',\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::ResourceDataSync`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4635 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSyncProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4534 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4657 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4676 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourceDataSync", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4538 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "SyncName" }, "stability": "external", "summary": "The name of the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4563 }, "name": "attrSyncName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4662 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname" }, "stability": "external", "summary": "A name for the resource data sync." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4570 }, "name": "syncName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname" }, "stability": "external", "summary": "The name of the S3 bucket where the aggregated data is stored." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4577 }, "name": "bucketName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix" }, "stability": "external", "summary": "An Amazon S3 prefix for the bucket." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4584 }, "name": "bucketPrefix", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion" }, "stability": "external", "summary": "The AWS Region with the S3 bucket targeted by the resource data sync." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4591 }, "name": "bucketRegion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn" }, "remarks": "You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.", "stability": "external", "summary": "The ARN of an encryption key for a destination in Amazon S3 ." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4598 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination" }, "stability": "external", "summary": "Configuration information for the target S3 bucket." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4605 }, "name": "s3Destination", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.S3DestinationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat" }, "remarks": "The following format is currently supported: JsonSerDe", "stability": "external", "summary": "A supported sync format." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4612 }, "name": "syncFormat", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource" }, "stability": "external", "summary": "Information about the source where the data was synchronized." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4619 }, "name": "syncSource", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.SyncSourceProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype" }, "remarks": "If `SyncType` is `SyncToDestination` , then the resource data sync synchronizes data to an S3 bucket. If the `SyncType` is `SyncFromSource` then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .", "stability": "external", "summary": "The type of resource data sync." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4626 }, "name": "syncType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnResourceDataSync" }, "@aws-cdk/aws-ssm.CfnResourceDataSync.AwsOrganizationsSourceProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html", "exampleMetadata": "fixture=_generated" }, "remarks": "A sync source of this type can synchronize data from AWS Organizations or, if an AWS organization isn't present, from multiple AWS Regions .", "stability": "external", "summary": "Information about the `AwsOrganizationsSource` resource data sync source.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst awsOrganizationsSourceProperty: ssm.CfnResourceDataSync.AwsOrganizationsSourceProperty = {\n organizationSourceType: 'organizationSourceType',\n\n // the properties below are optional\n organizationalUnits: ['organizationalUnits'],\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.AwsOrganizationsSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4690 }, "name": "AwsOrganizationsSourceProperty", "namespace": "CfnResourceDataSync", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype" }, "remarks": "For `OrganizationalUnits` , the data is aggregated from a set of organization units. For `EntireOrganization` , the data is aggregated from the entire AWS organization.", "stability": "external", "summary": "If an AWS organization is present, this is either `OrganizationalUnits` or `EntireOrganization` ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4696 }, "name": "organizationSourceType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits" }, "stability": "external", "summary": "The AWS Organizations organization units included in the sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4702 }, "name": "organizationalUnits", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/ssm.generated:CfnResourceDataSync.AwsOrganizationsSourceProperty" }, "@aws-cdk/aws-ssm.CfnResourceDataSync.S3DestinationProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Information about the target S3 bucket for the resource data sync.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst s3DestinationProperty: ssm.CfnResourceDataSync.S3DestinationProperty = {\n bucketName: 'bucketName',\n bucketRegion: 'bucketRegion',\n syncFormat: 'syncFormat',\n\n // the properties below are optional\n bucketPrefix: 'bucketPrefix',\n kmsKeyArn: 'kmsKeyArn',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.S3DestinationProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4767 }, "name": "S3DestinationProperty", "namespace": "CfnResourceDataSync", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname" }, "stability": "external", "summary": "The name of the S3 bucket where the aggregated data is stored." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4773 }, "name": "bucketName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion" }, "stability": "external", "summary": "The AWS Region with the S3 bucket targeted by the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4785 }, "name": "bucketRegion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-syncformat" }, "remarks": "The following format is currently supported: JsonSerDe", "stability": "external", "summary": "A supported sync format." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4797 }, "name": "syncFormat", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketprefix" }, "stability": "external", "summary": "An Amazon S3 prefix for the bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4779 }, "name": "bucketPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-kmskeyarn" }, "remarks": "Must belong to the same Region as the destination S3 bucket.", "stability": "external", "summary": "The ARN of an encryption key for a destination in Amazon S3." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4791 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnResourceDataSync.S3DestinationProperty" }, "@aws-cdk/aws-ssm.CfnResourceDataSync.SyncSourceProperty": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Information about the source of the data included in the resource data sync.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst syncSourceProperty: ssm.CfnResourceDataSync.SyncSourceProperty = {\n sourceRegions: ['sourceRegions'],\n sourceType: 'sourceType',\n\n // the properties below are optional\n awsOrganizationsSource: {\n organizationSourceType: 'organizationSourceType',\n\n // the properties below are optional\n organizationalUnits: ['organizationalUnits'],\n },\n includeFutureRegions: false,\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.SyncSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4873 }, "name": "SyncSourceProperty", "namespace": "CfnResourceDataSync", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourceregions" }, "stability": "external", "summary": "The `SyncSource` AWS Regions included in the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4891 }, "name": "sourceRegions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-sourcetype" }, "remarks": "`SourceType` is either `AwsOrganizations` (if an organization is present in AWS Organizations ) or `SingleAccountMultiRegions` .", "stability": "external", "summary": "The type of data source for the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4897 }, "name": "sourceType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-awsorganizationssource" }, "remarks": "A sync source of this type can synchronize data from AWS Organizations .", "stability": "external", "summary": "Information about the AwsOrganizationsSource resource data sync source." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4879 }, "name": "awsOrganizationsSource", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.AwsOrganizationsSourceProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.html#cfn-ssm-resourcedatasync-syncsource-includefutureregions" }, "stability": "external", "summary": "Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4885 }, "name": "includeFutureRegions", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/ssm.generated:CfnResourceDataSync.SyncSourceProperty" }, "@aws-cdk/aws-ssm.CfnResourceDataSyncProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourceDataSync`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst cfnResourceDataSyncProps: ssm.CfnResourceDataSyncProps = {\n syncName: 'syncName',\n\n // the properties below are optional\n bucketName: 'bucketName',\n bucketPrefix: 'bucketPrefix',\n bucketRegion: 'bucketRegion',\n kmsKeyArn: 'kmsKeyArn',\n s3Destination: {\n bucketName: 'bucketName',\n bucketRegion: 'bucketRegion',\n syncFormat: 'syncFormat',\n\n // the properties below are optional\n bucketPrefix: 'bucketPrefix',\n kmsKeyArn: 'kmsKeyArn',\n },\n syncFormat: 'syncFormat',\n syncSource: {\n sourceRegions: ['sourceRegions'],\n sourceType: 'sourceType',\n\n // the properties below are optional\n awsOrganizationsSource: {\n organizationSourceType: 'organizationSourceType',\n\n // the properties below are optional\n organizationalUnits: ['organizationalUnits'],\n },\n includeFutureRegions: false,\n },\n syncType: 'syncType',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSyncProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4376 }, "name": "CfnResourceDataSyncProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname" }, "stability": "external", "summary": "A name for the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4383 }, "name": "syncName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname" }, "stability": "external", "summary": "The name of the S3 bucket where the aggregated data is stored." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4390 }, "name": "bucketName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix" }, "stability": "external", "summary": "An Amazon S3 prefix for the bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4397 }, "name": "bucketPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion" }, "stability": "external", "summary": "The AWS Region with the S3 bucket targeted by the resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4404 }, "name": "bucketRegion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn" }, "remarks": "You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.", "stability": "external", "summary": "The ARN of an encryption key for a destination in Amazon S3 ." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4411 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination" }, "stability": "external", "summary": "Configuration information for the target S3 bucket." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4418 }, "name": "s3Destination", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.S3DestinationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat" }, "remarks": "The following format is currently supported: JsonSerDe", "stability": "external", "summary": "A supported sync format." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4425 }, "name": "syncFormat", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource" }, "stability": "external", "summary": "Information about the source where the data was synchronized." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4432 }, "name": "syncSource", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-ssm.CfnResourceDataSync.SyncSourceProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype" }, "remarks": "If `SyncType` is `SyncToDestination` , then the resource data sync synchronizes data to an S3 bucket. If the `SyncType` is `SyncFromSource` then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .", "stability": "external", "summary": "The type of resource data sync." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4439 }, "name": "syncType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnResourceDataSyncProps" }, "@aws-cdk/aws-ssm.CfnResourcePolicy": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::SSM::ResourcePolicy", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an AWS account ) that can manage your Systems Manager resources. Currently, `OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). OpsCenter is a capability of Systems Manager .", "stability": "external", "summary": "A CloudFormation `AWS::SSM::ResourcePolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const policy: any;\nconst cfnResourcePolicy = new ssm.CfnResourcePolicy(this, 'MyCfnResourcePolicy', {\n policy: policy,\n resourceArn: 'resourceArn',\n});" }, "fqn": "@aws-cdk/aws-ssm.CfnResourcePolicy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::SSM::ResourcePolicy`." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5103 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.CfnResourcePolicyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5045 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5120 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5132 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnResourcePolicy", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5049 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PolicyHash" }, "remarks": "The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash and the policy ID when updating or deleting a policy.", "stability": "external", "summary": "ID of the current policy version." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5074 }, "name": "attrPolicyHash", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "PolicyId" }, "stability": "external", "summary": "ID of the current policy version." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5080 }, "name": "attrPolicyId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5125 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-policy" }, "stability": "external", "summary": "A policy you want to associate with a resource." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5087 }, "name": "policy", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-resourcearn" }, "stability": "external", "summary": "Amazon Resource Name (ARN) of the resource to which you want to attach a policy." }, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 5094 }, "name": "resourceArn", "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnResourcePolicy" }, "@aws-cdk/aws-ssm.CfnResourcePolicyProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnResourcePolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\n\ndeclare const policy: any;\nconst cfnResourcePolicyProps: ssm.CfnResourcePolicyProps = {\n policy: policy,\n resourceArn: 'resourceArn',\n};" }, "fqn": "@aws-cdk/aws-ssm.CfnResourcePolicyProps", "kind": "interface", "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4968 }, "name": "CfnResourcePolicyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-policy" }, "stability": "external", "summary": "A policy you want to associate with a resource." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4975 }, "name": "policy", "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html#cfn-ssm-resourcepolicy-resourcearn" }, "stability": "external", "summary": "Amazon Resource Name (ARN) of the resource to which you want to attach a policy." }, "immutable": true, "locationInModule": { "filename": "lib/ssm.generated.ts", "line": 4982 }, "name": "resourceArn", "type": { "primitive": "string" } } ], "symbolId": "lib/ssm.generated:CfnResourcePolicyProps" }, "@aws-cdk/aws-ssm.CommonStringParameterAttributes": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "stability": "stable", "summary": "Common attributes for string parameters.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst commonStringParameterAttributes: ssm.CommonStringParameterAttributes = {\n parameterName: 'parameterName',\n\n // the properties below are optional\n simpleName: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-ssm.CommonStringParameterAttributes", "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 262 }, "name": "CommonStringParameterAttributes", "properties": [ { "abstract": true, "docs": { "remarks": "This value can be a token or a concrete string. If it is a concrete string\nand includes \"/\" it must also be prefixed with a \"/\" (fully-qualified).", "stability": "stable", "summary": "The name of the parameter store value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 269 }, "name": "parameterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-detect based on `parameterName`", "remarks": "This is only required only if `parameterName` is a token, which means we\nare unable to detect if the name is simple or \"path-like\" for the purpose\nof rendering SSM parameter ARNs.\n\nIf `parameterName` is not specified, `simpleName` must be `true` (or\nundefined) since the name generated by AWS CloudFormation is always a\nsimple name.", "stability": "stable", "summary": "Indicates of the parameter name is a simple name (i.e. does not include \"/\" separators)." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 285 }, "name": "simpleName", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/parameter:CommonStringParameterAttributes" }, "@aws-cdk/aws-ssm.IParameter": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "An SSM Parameter reference." }, "fqn": "@aws-cdk/aws-ssm.IParameter", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 16 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 40 }, "name": "grantRead", "parameters": [ { "docs": { "summary": "the role to be granted read-only access to the parameter." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants write (PutParameter) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 47 }, "name": "grantWrite", "parameters": [ { "docs": { "summary": "the role to be granted write access to the parameter." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "IParameter", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 21 }, "name": "parameterArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 27 }, "name": "parameterName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The type of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 33 }, "name": "parameterType", "type": { "primitive": "string" } } ], "symbolId": "lib/parameter:IParameter" }, "@aws-cdk/aws-ssm.IStringListParameter": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "A StringList SSM Parameter." }, "fqn": "@aws-cdk/aws-ssm.IStringListParameter", "interfaces": [ "@aws-cdk/aws-ssm.IParameter" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 65 }, "name": "IStringListParameter", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "Value" }, "remarks": "Value must not nest another parameter. Do not use {{}} in the value. Values in the array\ncannot contain commas (``,``).", "stability": "stable", "summary": "The parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 72 }, "name": "stringListValue", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/parameter:IStringListParameter" }, "@aws-cdk/aws-ssm.IStringParameter": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "A String SSM Parameter." }, "fqn": "@aws-cdk/aws-ssm.IStringParameter", "interfaces": [ "@aws-cdk/aws-ssm.IParameter" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 53 }, "name": "IStringParameter", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "Value" }, "remarks": "Value must not nest another parameter. Do not use {{}} in the value.", "stability": "stable", "summary": "The parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 59 }, "name": "stringValue", "type": { "primitive": "string" } } ], "symbolId": "lib/parameter:IStringParameter" }, "@aws-cdk/aws-ssm.ParameterDataType": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "SSM parameter data type." }, "fqn": "@aws-cdk/aws-ssm.ParameterDataType", "kind": "enum", "locationInModule": { "filename": "lib/parameter.ts", "line": 230 }, "members": [ { "docs": { "stability": "stable", "summary": "Text." }, "name": "TEXT" }, { "docs": { "stability": "stable", "summary": "Aws Ec2 Image." }, "name": "AWS_EC2_IMAGE" } ], "name": "ParameterDataType", "symbolId": "lib/parameter:ParameterDataType" }, "@aws-cdk/aws-ssm.ParameterOptions": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "stability": "stable", "summary": "Properties needed to create a new SSM Parameter.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ssm from '@aws-cdk/aws-ssm';\nconst parameterOptions: ssm.ParameterOptions = {\n allowedPattern: 'allowedPattern',\n description: 'description',\n parameterName: 'parameterName',\n simpleName: false,\n tier: ssm.ParameterTier.ADVANCED,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-ssm.ParameterOptions", "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 78 }, "name": "ParameterOptions", "properties": [ { "abstract": true, "docs": { "default": "no validation is performed", "remarks": "For example, for String types with values restricted to\nnumbers, you can specify the following: ``^\\d+$``", "stability": "stable", "summary": "A regular expression used to validate the parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 85 }, "name": "allowedPattern", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "none", "stability": "stable", "summary": "Information about the parameter that you want to add to the system." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 92 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- a name will be generated by CloudFormation", "stability": "stable", "summary": "The name of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 99 }, "name": "parameterName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-detect based on `parameterName`", "remarks": "This is only required only if `parameterName` is a token, which means we\nare unable to detect if the name is simple or \"path-like\" for the purpose\nof rendering SSM parameter ARNs.\n\nIf `parameterName` is not specified, `simpleName` must be `true` (or\nundefined) since the name generated by AWS CloudFormation is always a\nsimple name.", "stability": "stable", "summary": "Indicates of the parameter name is a simple name (i.e. does not include \"/\" separators)." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 115 }, "name": "simpleName", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined", "stability": "stable", "summary": "The tier of the string parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 122 }, "name": "tier", "optional": true, "type": { "fqn": "@aws-cdk/aws-ssm.ParameterTier" } } ], "symbolId": "lib/parameter:ParameterOptions" }, "@aws-cdk/aws-ssm.ParameterTier": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "SSM parameter tier.", "example": "new ssm.StringParameter(this, 'Parameter', {\n allowedPattern: '.*',\n description: 'The value Foo',\n parameterName: 'FooParameter',\n stringValue: 'Foo',\n tier: ssm.ParameterTier.ADVANCED,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-ssm.ParameterTier", "kind": "enum", "locationInModule": { "filename": "lib/parameter.ts", "line": 244 }, "members": [ { "docs": { "stability": "stable", "summary": "String." }, "name": "ADVANCED" }, { "docs": { "stability": "stable", "summary": "String." }, "name": "INTELLIGENT_TIERING" }, { "docs": { "stability": "stable", "summary": "String." }, "name": "STANDARD" } ], "name": "ParameterTier", "symbolId": "lib/parameter:ParameterTier" }, "@aws-cdk/aws-ssm.ParameterType": { "assembly": "@aws-cdk/aws-ssm", "docs": { "stability": "stable", "summary": "SSM parameter type." }, "fqn": "@aws-cdk/aws-ssm.ParameterType", "kind": "enum", "locationInModule": { "filename": "lib/parameter.ts", "line": 205 }, "members": [ { "docs": { "stability": "stable", "summary": "String." }, "name": "STRING" }, { "docs": { "remarks": "Parameter Store uses an AWS Key Management Service (KMS) customer master key (CMK) to encrypt the parameter value.\nParameters of type SecureString cannot be created directly from a CDK application.", "stability": "stable", "summary": "Secure String." }, "name": "SECURE_STRING" }, { "docs": { "stability": "stable", "summary": "String List." }, "name": "STRING_LIST" }, { "docs": { "stability": "stable", "summary": "An Amazon EC2 image ID, such as ami-0ff8a91507f77f867." }, "name": "AWS_EC2_IMAGE_ID" } ], "name": "ParameterType", "symbolId": "lib/parameter:ParameterType" }, "@aws-cdk/aws-ssm.SecureStringParameterAttributes": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for secure string parameters.", "example": " // Retrieve the latest value of the non-secret parameter\n // with name \"/My/String/Parameter\".\n const stringValue = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValue', {\n parameterName: '/My/Public/Parameter',\n // 'version' can be specified but is optional.\n }).stringValue;\n const stringValueVersionFromToken = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValueVersionFromToken', {\n parameterName: '/My/Public/Parameter',\n // parameter version from token\n version: parameterVersion,\n }).stringValue;\n\n // Retrieve a specific version of the secret (SecureString) parameter.\n // 'version' is always required.\n const secretValue = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValue', {\n parameterName: '/My/Secret/Parameter',\n version: 5,\n });\n const secretValueVersionFromToken = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValueVersionFromToken', {\n parameterName: '/My/Secret/Parameter',\n // parameter version from token\n version: parameterVersion,\n });", "custom": { "exampleMetadata": "lit=test/integ.parameter-store-string.lit.ts infused" } }, "fqn": "@aws-cdk/aws-ssm.SecureStringParameterAttributes", "interfaces": [ "@aws-cdk/aws-ssm.CommonStringParameterAttributes" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 312 }, "name": "SecureStringParameterAttributes", "properties": [ { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "The encryption key that is used to encrypt this parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 325 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "- AWS CloudFormation uses the latest version of the parameter", "stability": "stable", "summary": "The version number of the value you wish to retrieve." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 318 }, "name": "version", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/parameter:SecureStringParameterAttributes" }, "@aws-cdk/aws-ssm.StringListParameter": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::SSM::Parameter", "exampleMetadata": "lit=test/integ.parameter.lit.ts infused" }, "stability": "stable", "summary": "Creates a new StringList SSM Parameter.", "example": "// Create a new SSM Parameter holding a String\nconst param = new ssm.StringParameter(stack, 'StringParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringValue: 'Initial parameter value',\n // allowedPattern: '.*',\n});\n\n// Grant read access to some Role\nparam.grantRead(role);\n\n// Create a new SSM Parameter holding a StringList\nconst listParameter = new ssm.StringListParameter(stack, 'StringListParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringListValue: ['Initial parameter value A', 'Initial parameter value B'],\n // allowedPattern: '.*',\n});" }, "fqn": "@aws-cdk/aws-ssm.StringListParameter", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/parameter.ts", "line": 515 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.StringListParameterProps" } } ] }, "interfaces": [ "@aws-cdk/aws-ssm.IStringListParameter", "@aws-cdk/aws-ssm.IParameter" ], "kind": "class", "locationInModule": { "filename": "lib/parameter.ts", "line": 493 }, "methods": [ { "docs": { "remarks": "Returns a token and should not be parsed.", "stability": "stable", "summary": "Imports an external parameter of type string list." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 499 }, "name": "fromStringListParameterName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "stringListParameterName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-ssm.IStringListParameter" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 174 }, "name": "grantRead", "overrides": "@aws-cdk/aws-ssm.IParameter", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Grants write (PutParameter) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 190 }, "name": "grantWrite", "overrides": "@aws-cdk/aws-ssm.IParameter", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "StringListParameter", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 510 }, "name": "parameterArn", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 511 }, "name": "parameterName", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The type of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 512 }, "name": "parameterType", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "remarks": "Value must not nest another parameter. Do not use {{}} in the value. Values in the array\ncannot contain commas (``,``).", "stability": "stable", "summary": "The parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 513 }, "name": "stringListValue", "overrides": "@aws-cdk/aws-ssm.IStringListParameter", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "remarks": "* @default - default master key", "stability": "stable", "summary": "The encryption key that is used to encrypt this parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 172 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "symbolId": "lib/parameter:StringListParameter" }, "@aws-cdk/aws-ssm.StringListParameterProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "stability": "stable", "summary": "Properties needed to create a StringList SSM Parameter.", "example": "// Create a new SSM Parameter holding a String\nconst param = new ssm.StringParameter(stack, 'StringParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringValue: 'Initial parameter value',\n // allowedPattern: '.*',\n});\n\n// Grant read access to some Role\nparam.grantRead(role);\n\n// Create a new SSM Parameter holding a StringList\nconst listParameter = new ssm.StringListParameter(stack, 'StringListParameter', {\n // description: 'Some user-friendly description',\n // name: 'ParameterName',\n stringListValue: ['Initial parameter value A', 'Initial parameter value B'],\n // allowedPattern: '.*',\n});", "custom": { "exampleMetadata": "lit=test/integ.parameter.lit.ts infused" } }, "fqn": "@aws-cdk/aws-ssm.StringListParameterProps", "interfaces": [ "@aws-cdk/aws-ssm.ParameterOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 152 }, "name": "StringListParameterProps", "properties": [ { "abstract": true, "docs": { "remarks": "It may not reference another parameter and ``{{}}`` cannot be used in the value.", "stability": "stable", "summary": "The values of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 156 }, "name": "stringListValue", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/parameter:StringListParameterProps" }, "@aws-cdk/aws-ssm.StringParameter": { "assembly": "@aws-cdk/aws-ssm", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::SSM::Parameter", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Creates a new String SSM Parameter.", "example": "const vpc = ec2.Vpc.fromVpcAttributes(this, 'VPC', {\n vpcId: 'vpc-1234',\n availabilityZones: ['us-east-1a', 'us-east-1b'],\n\n // Either pass literals for all IDs\n publicSubnetIds: ['s-12345', 's-67890'],\n\n // OR: import a list of known length\n privateSubnetIds: Fn.importListValue('PrivateSubnetIds', 2),\n\n // OR: split an imported string to a list of known length\n isolatedSubnetIds: Fn.split(',', ssm.StringParameter.valueForStringParameter(this, `MyParameter`), 2),\n});" }, "fqn": "@aws-cdk/aws-ssm.StringParameter", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/parameter.ts", "line": 449 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-ssm.StringParameterProps" } } ] }, "interfaces": [ "@aws-cdk/aws-ssm.IStringParameter", "@aws-cdk/aws-ssm.IParameter" ], "kind": "class", "locationInModule": { "filename": "lib/parameter.ts", "line": 333 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a secure string parameter from the SSM parameter store." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 369 }, "name": "fromSecureStringParameterAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-ssm.SecureStringParameterAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-ssm.IStringParameter" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Imports an external string parameter with name and optional version." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 345 }, "name": "fromStringParameterAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-ssm.StringParameterAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-ssm.IStringParameter" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Imports an external string parameter by name." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 338 }, "name": "fromStringParameterName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "stringParameterName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-ssm.IStringParameter" } }, "static": true }, { "docs": { "deprecated": "Use `SecretValue.ssmSecure()` instead, it will correctly type the imported value as a `SecretValue` and allow importing without version.", "stability": "deprecated", "summary": "Returns a token that will resolve (during deployment)." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 435 }, "name": "valueForSecureStringParameter", "parameters": [ { "docs": { "summary": "Some scope within a stack." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The name of the SSM parameter." }, "name": "parameterName", "type": { "primitive": "string" } }, { "docs": { "summary": "The parameter version (required for secure strings)." }, "name": "version", "type": { "primitive": "number" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Returns a token that will resolve (during deployment) to the string value of an SSM string parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 407 }, "name": "valueForStringParameter", "parameters": [ { "docs": { "summary": "Some scope within a stack." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The name of the SSM parameter." }, "name": "parameterName", "type": { "primitive": "string" } }, { "docs": { "summary": "The parameter version (recommended in order to ensure that the value won't change during deployment)." }, "name": "version", "optional": true, "type": { "primitive": "number" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Returns a token that will resolve (during deployment) to the string value of an SSM string parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 418 }, "name": "valueForTypedStringParameter", "parameters": [ { "docs": { "summary": "Some scope within a stack." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The name of the SSM parameter." }, "name": "parameterName", "type": { "primitive": "string" } }, { "docs": { "summary": "The type of the SSM parameter." }, "name": "type", "optional": true, "type": { "fqn": "@aws-cdk/aws-ssm.ParameterType" } }, { "docs": { "summary": "The parameter version (recommended in order to ensure that the value won't change during deployment)." }, "name": "version", "optional": true, "type": { "primitive": "number" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "remarks": "Requires that the stack this scope is defined in will have explicit\naccount/region information. Otherwise, it will fail during synthesis.", "stability": "stable", "summary": "Reads the value of an SSM parameter during synthesis through an environmental context provider." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 391 }, "name": "valueFromLookup", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "parameterName", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "string" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 174 }, "name": "grantRead", "overrides": "@aws-cdk/aws-ssm.IParameter", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Grants write (PutParameter) permissions on the SSM Parameter." }, "locationInModule": { "filename": "lib/parameter.ts", "line": 190 }, "name": "grantWrite", "overrides": "@aws-cdk/aws-ssm.IParameter", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "StringParameter", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 444 }, "name": "parameterArn", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 445 }, "name": "parameterName", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The type of the SSM Parameter resource." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 446 }, "name": "parameterType", "overrides": "@aws-cdk/aws-ssm.IParameter", "type": { "primitive": "string" } }, { "docs": { "remarks": "Value must not nest another parameter. Do not use {{}} in the value.", "stability": "stable", "summary": "The parameter value." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 447 }, "name": "stringValue", "overrides": "@aws-cdk/aws-ssm.IStringParameter", "type": { "primitive": "string" } }, { "docs": { "remarks": "* @default - default master key", "stability": "stable", "summary": "The encryption key that is used to encrypt this parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 172 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "symbolId": "lib/parameter:StringParameter" }, "@aws-cdk/aws-ssm.StringParameterAttributes": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "see": "ParameterType", "stability": "stable", "summary": "Attributes for parameters of various types of string.", "example": " // Retrieve the latest value of the non-secret parameter\n // with name \"/My/String/Parameter\".\n const stringValue = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValue', {\n parameterName: '/My/Public/Parameter',\n // 'version' can be specified but is optional.\n }).stringValue;\n const stringValueVersionFromToken = ssm.StringParameter.fromStringParameterAttributes(this, 'MyValueVersionFromToken', {\n parameterName: '/My/Public/Parameter',\n // parameter version from token\n version: parameterVersion,\n }).stringValue;\n\n // Retrieve a specific version of the secret (SecureString) parameter.\n // 'version' is always required.\n const secretValue = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValue', {\n parameterName: '/My/Secret/Parameter',\n version: 5,\n });\n const secretValueVersionFromToken = ssm.StringParameter.fromSecureStringParameterAttributes(this, 'MySecureValueVersionFromToken', {\n parameterName: '/My/Secret/Parameter',\n // parameter version from token\n version: parameterVersion,\n });", "custom": { "exampleMetadata": "lit=test/integ.parameter-store-string.lit.ts infused" } }, "fqn": "@aws-cdk/aws-ssm.StringParameterAttributes", "interfaces": [ "@aws-cdk/aws-ssm.CommonStringParameterAttributes" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 293 }, "name": "StringParameterAttributes", "properties": [ { "abstract": true, "docs": { "default": "ParameterType.STRING", "stability": "stable", "summary": "The type of the string parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 306 }, "name": "type", "optional": true, "type": { "fqn": "@aws-cdk/aws-ssm.ParameterType" } }, { "abstract": true, "docs": { "default": "The latest version will be retrieved.", "stability": "stable", "summary": "The version number of the value you wish to retrieve." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 299 }, "name": "version", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/parameter:StringParameterAttributes" }, "@aws-cdk/aws-ssm.StringParameterProps": { "assembly": "@aws-cdk/aws-ssm", "datatype": true, "docs": { "stability": "stable", "summary": "Properties needed to create a String SSM parameter.", "example": "new ssm.StringParameter(this, 'Parameter', {\n allowedPattern: '.*',\n description: 'The value Foo',\n parameterName: 'FooParameter',\n stringValue: 'Foo',\n tier: ssm.ParameterTier.ADVANCED,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-ssm.StringParameterProps", "interfaces": [ "@aws-cdk/aws-ssm.ParameterOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter.ts", "line": 128 }, "name": "StringParameterProps", "properties": [ { "abstract": true, "docs": { "remarks": "It may not reference another parameter and ``{{}}`` cannot be used in the value.", "stability": "stable", "summary": "The value of the parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 132 }, "name": "stringValue", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "ParameterDataType.TEXT", "stability": "stable", "summary": "The data type of the parameter, such as `text` or `aws:ec2:image`." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 146 }, "name": "dataType", "optional": true, "type": { "fqn": "@aws-cdk/aws-ssm.ParameterDataType" } }, { "abstract": true, "docs": { "default": "ParameterType.STRING", "stability": "stable", "summary": "The type of the string parameter." }, "immutable": true, "locationInModule": { "filename": "lib/parameter.ts", "line": 139 }, "name": "type", "optional": true, "type": { "fqn": "@aws-cdk/aws-ssm.ParameterType" } } ], "symbolId": "lib/parameter:StringParameterProps" } }, "version": "1.204.0", "fingerprint": "**********" }