ssm/aws.sdk.kotlin.services.ssm.model/AutomationExecutionMetadata/Builder

Builder

Properties

alarmConfiguration

var alarmConfiguration: AlarmConfiguration?

The details for the CloudWatch alarm applied to your automation.

var associationId: String?

The ID of a State Manager association used in the Automation operation.

automationExecutionId

var automationExecutionId: String?

The execution ID.

automationExecutionStatus

var automationExecutionStatus: AutomationExecutionStatus?

The status of the execution.

automationSubtype

var automationSubtype: AutomationSubtype?

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

var automationType: AutomationType?

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

changeRequestName

var changeRequestName: String?

The name of the Change Manager change request.

var currentAction: String?

The action of the step that is currently running.

currentStepName

var currentStepName: String?

The name of the step that is currently running.

var documentName: String?

The name of the Automation runbook used during execution.

documentVersion

var documentVersion: String?

The document version used during the execution.

var executedBy: String?

The IAM role ARN of the user who ran the automation.

executionEndTime

var executionEndTime: Instant?

The time the execution finished. This isn't populated if the execution is still in progress.

executionStartTime

var executionStartTime: Instant?

The time the execution started.

var failureMessage: String?

The list of execution outputs as defined in the Automation runbook.

var logFile: String?

An S3 bucket where execution information is stored.

var maxConcurrency: String?

The MaxConcurrency value specified by the user when starting the automation.

var maxErrors: String?

The MaxErrors value specified by the user when starting the automation.

var mode: ExecutionMode?

The Automation execution mode.

var opsItemId: String?

The ID of an OpsItem that is created to represent a Change Manager change request.

var outputs: Map<String, List<String>>?

The list of execution outputs as defined in the Automation runbook.

parentAutomationExecutionId

var parentAutomationExecutionId: String?

The execution ID of the parent automation.

resolvedTargets

var resolvedTargets: ResolvedTargets?

A list of targets that resolved during the execution.

var runbooks: List<Runbook>?

Information about the Automation runbooks that are run during a runbook workflow in Change Manager.

var scheduledTime: Instant?

The date and time the Automation operation is scheduled to start.

var target: String?

The list of execution outputs as defined in the Automation runbook.

targetLocationsUrl

var targetLocationsUrl: String?

A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

var targetMaps: List<Map<String, List<String>>>?

The specified key-value mapping of document parameters to target resources.

targetParameterName

var targetParameterName: String?

The list of execution outputs as defined in the Automation runbook.

var targets: List<Target>?

The targets defined by the user when starting the automation.

triggeredAlarms

var triggeredAlarms: List<AlarmStateInformation>?

The CloudWatch alarm that was invoked by the automation.

Functions

alarmConfiguration

fun alarmConfiguration(block: AlarmConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.AlarmConfiguration inside the given block

resolvedTargets

fun resolvedTargets(block: ResolvedTargets.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ssm.model.ResolvedTargets inside the given block