Interface CfnResponsePlan.SsmAutomationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnResponsePlan.SsmAutomationProperty extends
The SsmAutomation property type specifies details about the Systems Manager automation document that will be used as a runbook during an incident.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 SsmAutomationProperty ssmAutomationProperty = SsmAutomationProperty.builder()
         // the properties below are optional
  • Method Details

    • getDocumentName

      @Stability(Stable) @NotNull String getDocumentName()
      The automation document's name.
    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    • getDocumentVersion

      @Stability(Stable) @Nullable default String getDocumentVersion()
      The automation document's version to use when running.
    • getDynamicParameters

      @Stability(Stable) @Nullable default Object getDynamicParameters()
      The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    • getParameters

      @Stability(Stable) @Nullable default Object getParameters()
      The key-value pair parameters to use when running the automation document.
    • getTargetAccount

      @Stability(Stable) @Nullable default String getTargetAccount()
      The account that the automation document will be run in.

      This can be in either the management account or an application account.

    • builder

      @Stability(Stable) static CfnResponsePlan.SsmAutomationProperty.Builder builder()
      a CfnResponsePlan.SsmAutomationProperty.Builder of CfnResponsePlan.SsmAutomationProperty