| Interface | Description |
|---|---|
| CfnAssociation.InstanceAssociationOutputLocationProperty |
`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.
|
| CfnAssociation.S3OutputLocationProperty |
`S3OutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.
|
| CfnAssociation.TargetProperty |
`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 .
|
| CfnAssociationProps |
Properties for defining a `CfnAssociation`.
|
| CfnDocument.AttachmentsSourceProperty |
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.
|
| CfnDocument.DocumentRequiresProperty |
An SSM document required by the current document.
|
| CfnDocumentProps |
Properties for defining a `CfnDocument`.
|
| CfnMaintenanceWindowProps |
Properties for defining a `CfnMaintenanceWindow`.
|
| CfnMaintenanceWindowTarget.TargetsProperty |
The `Targets` property type specifies adding a target to a maintenance window target in AWS Systems Manager .
|
| CfnMaintenanceWindowTargetProps |
Properties for defining a `CfnMaintenanceWindowTarget`.
|
| CfnMaintenanceWindowTask.LoggingInfoProperty |
The `LoggingInfo` property type specifies information about the Amazon S3 bucket to write instance-level logs to.
|
| CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty |
The `MaintenanceWindowAutomationParameters` property type specifies the parameters for an `AUTOMATION` task type for a maintenance window task in AWS Systems Manager .
|
| CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty |
The `MaintenanceWindowLambdaParameters` property type specifies the parameters for a `LAMBDA` task type for a maintenance window task in AWS Systems Manager .
|
| CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty |
The `MaintenanceWindowRunCommandParameters` property type specifies the parameters for a `RUN_COMMAND` task type for a maintenance window task in AWS Systems Manager .
|
| CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty |
The `MaintenanceWindowStepFunctionsParameters` property type specifies the parameters for the execution of a `STEP_FUNCTIONS` task in a Systems Manager maintenance window.
|
| CfnMaintenanceWindowTask.NotificationConfigProperty |
The `NotificationConfig` property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .
|
| CfnMaintenanceWindowTask.TargetProperty |
The `Target` property type specifies targets (either instances or window target IDs).
|
| CfnMaintenanceWindowTask.TaskInvocationParametersProperty |
The `TaskInvocationParameters` property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .
|
| CfnMaintenanceWindowTaskProps |
Properties for defining a `CfnMaintenanceWindowTask`.
|
| CfnParameterProps |
Properties for defining a `CfnParameter`.
|
| CfnPatchBaseline.PatchFilterGroupProperty |
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.
|
| CfnPatchBaseline.PatchFilterProperty |
The `PatchFilter` property type defines a patch filter for an AWS Systems Manager patch baseline.
|
| CfnPatchBaseline.PatchSourceProperty |
`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.
|
| CfnPatchBaseline.RuleGroupProperty |
The `RuleGroup` property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline.
|
| CfnPatchBaseline.RuleProperty |
The `Rule` property type specifies an approval rule for a Systems Manager patch baseline.
|
| CfnPatchBaselineProps |
Properties for defining a `CfnPatchBaseline`.
|
| CfnResourceDataSync.AwsOrganizationsSourceProperty |
Information about the `AwsOrganizationsSource` resource data sync source.
|
| CfnResourceDataSync.S3DestinationProperty |
Information about the target S3 bucket for the resource data sync.
|
| CfnResourceDataSync.SyncSourceProperty |
Information about the source of the data included in the resource data sync.
|
| CfnResourceDataSyncProps |
Properties for defining a `CfnResourceDataSync`.
|
| CommonStringParameterAttributes |
(experimental) Common attributes for string parameters.
|
| IParameter |
(experimental) An SSM Parameter reference.
|
| IParameter.Jsii$Default |
Internal default implementation for
IParameter. |
| IStringListParameter |
(experimental) A StringList SSM Parameter.
|
| IStringListParameter.Jsii$Default |
Internal default implementation for
IStringListParameter. |
| IStringParameter |
(experimental) A String SSM Parameter.
|
| IStringParameter.Jsii$Default |
Internal default implementation for
IStringParameter. |
| ParameterOptions |
(experimental) Properties needed to create a new SSM Parameter.
|
| SecureStringParameterAttributes |
(experimental) Attributes for secure string parameters.
|
| StringListParameterProps |
(experimental) Properties needed to create a StringList SSM Parameter.
|
| StringParameterAttributes |
(experimental) Attributes for parameters of various types of string.
|
| StringParameterProps |
(experimental) Properties needed to create a String SSM parameter.
|
| Enum | Description |
|---|---|
| ParameterDataType |
(experimental) SSM parameter data type.
|
| ParameterTier |
(experimental) SSM parameter tier.
|
| ParameterType |
(experimental) SSM parameter type.
|
This module is part of the AWS Cloud Development Kit project.
Install the module:
$ npm i @aws-cdk/aws-ssm
Import it into your code:
import software.amazon.awscdk.core.*;
You can reference existing SSM Parameter Store values that you want to use in
your CDK app by using ssm.ParameterStoreString:
You can create either ssm.StringParameter or ssm.StringListParameters in
a CDK app. These are public (not secret) values. Parameters of type
SecureString cannot be created directly from a CDK application; if you want
to provision secrets automatically, use Secrets Manager Secrets (see the
@aws-cdk/aws-secretsmanager package).
StringParameter.Builder.create(this, "Parameter")
.allowedPattern(".*")
.description("The value Foo")
.parameterName("FooParameter")
.stringValue("Foo")
.tier(ParameterTier.ADVANCED)
.build();
When specifying an allowedPattern, the values provided as string literals
are validated against the pattern and an exception is raised if a value
provided does not comply.
Copyright © 2022. All rights reserved.