TaskInvocationParametersProperty Struct
The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .
TaskInvocationParameters is a property of the AWS::SSM::MaintenanceWindowTask property type.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
declare const parameters: any;
const taskInvocationParametersProperty: ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty = {
maintenanceWindowAutomationParameters: {
documentVersion: 'documentVersion',
parameters: parameters,
},
maintenanceWindowLambdaParameters: {
clientContext: 'clientContext',
payload: 'payload',
qualifier: 'qualifier',
},
maintenanceWindowRunCommandParameters: {
cloudWatchOutputConfig: {
cloudWatchLogGroupName: 'cloudWatchLogGroupName',
cloudWatchOutputEnabled: false,
},
comment: 'comment',
documentHash: 'documentHash',
documentHashType: 'documentHashType',
documentVersion: 'documentVersion',
notificationConfig: {
notificationArn: 'notificationArn',
// the properties below are optional
notificationEvents: ['notificationEvents'],
notificationType: 'notificationType',
},
outputS3BucketName: 'outputS3BucketName',
outputS3KeyPrefix: 'outputS3KeyPrefix',
parameters: parameters,
serviceRoleArn: 'serviceRoleArn',
timeoutSeconds: 123,
},
maintenanceWindowStepFunctionsParameters: {
input: 'input',
name: 'name',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssm as ssm
# parameters: Any
task_invocation_parameters_property = ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty(
maintenance_window_automation_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty(
document_version="documentVersion",
parameters=parameters
),
maintenance_window_lambda_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty(
client_context="clientContext",
payload="payload",
qualifier="qualifier"
),
maintenance_window_run_command_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty(
cloud_watch_output_config=ssm.CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty(
cloud_watch_log_group_name="cloudWatchLogGroupName",
cloud_watch_output_enabled=False
),
comment="comment",
document_hash="documentHash",
document_hash_type="documentHashType",
document_version="documentVersion",
notification_config=ssm.CfnMaintenanceWindowTask.NotificationConfigProperty(
notification_arn="notificationArn",
# the properties below are optional
notification_events=["notificationEvents"],
notification_type="notificationType"
),
output_s3_bucket_name="outputS3BucketName",
output_s3_key_prefix="outputS3KeyPrefix",
parameters=parameters,
service_role_arn="serviceRoleArn",
timeout_seconds=123
),
maintenance_window_step_functions_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty(
input="input",
name="name"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ssm.*;
Object parameters;
TaskInvocationParametersProperty taskInvocationParametersProperty = TaskInvocationParametersProperty.builder()
.maintenanceWindowAutomationParameters(MaintenanceWindowAutomationParametersProperty.builder()
.documentVersion("documentVersion")
.parameters(parameters)
.build())
.maintenanceWindowLambdaParameters(MaintenanceWindowLambdaParametersProperty.builder()
.clientContext("clientContext")
.payload("payload")
.qualifier("qualifier")
.build())
.maintenanceWindowRunCommandParameters(MaintenanceWindowRunCommandParametersProperty.builder()
.cloudWatchOutputConfig(CloudWatchOutputConfigProperty.builder()
.cloudWatchLogGroupName("cloudWatchLogGroupName")
.cloudWatchOutputEnabled(false)
.build())
.comment("comment")
.documentHash("documentHash")
.documentHashType("documentHashType")
.documentVersion("documentVersion")
.notificationConfig(NotificationConfigProperty.builder()
.notificationArn("notificationArn")
// the properties below are optional
.notificationEvents(List.of("notificationEvents"))
.notificationType("notificationType")
.build())
.outputS3BucketName("outputS3BucketName")
.outputS3KeyPrefix("outputS3KeyPrefix")
.parameters(parameters)
.serviceRoleArn("serviceRoleArn")
.timeoutSeconds(123)
.build())
.maintenanceWindowStepFunctionsParameters(MaintenanceWindowStepFunctionsParametersProperty.builder()
.input("input")
.name("name")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var parameters;
var taskInvocationParametersProperty = new TaskInvocationParametersProperty {
MaintenanceWindowAutomationParameters = new MaintenanceWindowAutomationParametersProperty {
DocumentVersion = "documentVersion",
Parameters = parameters
},
MaintenanceWindowLambdaParameters = new MaintenanceWindowLambdaParametersProperty {
ClientContext = "clientContext",
Payload = "payload",
Qualifier = "qualifier"
},
MaintenanceWindowRunCommandParameters = new MaintenanceWindowRunCommandParametersProperty {
CloudWatchOutputConfig = new CloudWatchOutputConfigProperty {
CloudWatchLogGroupName = "cloudWatchLogGroupName",
CloudWatchOutputEnabled = false
},
Comment = "comment",
DocumentHash = "documentHash",
DocumentHashType = "documentHashType",
DocumentVersion = "documentVersion",
NotificationConfig = new NotificationConfigProperty {
NotificationArn = "notificationArn",
// the properties below are optional
NotificationEvents = new [] { "notificationEvents" },
NotificationType = "notificationType"
},
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
Parameters = parameters,
ServiceRoleArn = "serviceRoleArn",
TimeoutSeconds = 123
},
MaintenanceWindowStepFunctionsParameters = new MaintenanceWindowStepFunctionsParametersProperty {
Input = "input",
Name = "name"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var parameters interface{}
taskInvocationParametersProperty := &TaskInvocationParametersProperty{
MaintenanceWindowAutomationParameters: &MaintenanceWindowAutomationParametersProperty{
DocumentVersion: jsii.String("documentVersion"),
Parameters: parameters,
},
MaintenanceWindowLambdaParameters: &MaintenanceWindowLambdaParametersProperty{
ClientContext: jsii.String("clientContext"),
Payload: jsii.String("payload"),
Qualifier: jsii.String("qualifier"),
},
MaintenanceWindowRunCommandParameters: &MaintenanceWindowRunCommandParametersProperty{
CloudWatchOutputConfig: &CloudWatchOutputConfigProperty{
CloudWatchLogGroupName: jsii.String("cloudWatchLogGroupName"),
CloudWatchOutputEnabled: jsii.Boolean(false),
},
Comment: jsii.String("comment"),
DocumentHash: jsii.String("documentHash"),
DocumentHashType: jsii.String("documentHashType"),
DocumentVersion: jsii.String("documentVersion"),
NotificationConfig: &NotificationConfigProperty{
NotificationArn: jsii.String("notificationArn"),
// the properties below are optional
NotificationEvents: []*string{
jsii.String("notificationEvents"),
},
NotificationType: jsii.String("notificationType"),
},
OutputS3BucketName: jsii.String("outputS3BucketName"),
OutputS3KeyPrefix: jsii.String("outputS3KeyPrefix"),
Parameters: parameters,
ServiceRoleArn: jsii.String("serviceRoleArn"),
TimeoutSeconds: jsii.Number(123),
},
MaintenanceWindowStepFunctionsParameters: &MaintenanceWindowStepFunctionsParametersProperty{
Input: jsii.String("input"),
Name: jsii.String("name"),
},
}
Properties
maintenanceWindowAutomationParametersoptionalIResolvable | CfnMaintenanceWindowTask.maintenance_window_automation_parametersoptionaltyping.Union[IResolvable, MaintenanceWindowAutomationParametersProperty]maintenanceWindowAutomationParametersoptionalIResolvableMaintenanceWindowAutomationParametersoptionalIResolvableMaintenanceWindowAutomationParametersoptionalinterface{} #The parameters for an `AUTOMATION` task type.
maintenanceWindowLambdaParametersoptionalIResolvable | CfnMaintenanceWindowTask.maintenance_window_lambda_parametersoptionaltyping.Union[IResolvable, MaintenanceWindowLambdaParametersProperty]maintenanceWindowLambdaParametersoptionalIResolvableMaintenanceWindowLambdaParametersoptionalIResolvableMaintenanceWindowLambdaParametersoptionalinterface{} #The parameters for a `LAMBDA` task type.
maintenanceWindowRunCommandParametersoptionalIResolvable | CfnMaintenanceWindowTask.maintenance_window_run_command_parametersoptionaltyping.Union[IResolvable, MaintenanceWindowRunCommandParametersProperty]maintenanceWindowRunCommandParametersoptionalIResolvableMaintenanceWindowRunCommandParametersoptionalIResolvableMaintenanceWindowRunCommandParametersoptionalinterface{} #The parameters for a `RUN_COMMAND` task type.
maintenanceWindowStepFunctionsParametersoptionalIResolvable | CfnMaintenanceWindowTask.maintenance_window_step_functions_parametersoptionaltyping.Union[IResolvable, MaintenanceWindowStepFunctionsParametersProperty]maintenanceWindowStepFunctionsParametersoptionalIResolvableMaintenanceWindowStepFunctionsParametersoptionalIResolvableMaintenanceWindowStepFunctionsParametersoptionalinterface{} #The parameters for a `STEP_FUNCTIONS` task type.