awscc.ssmincidents_responseplan

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - ssm-incidents:DeleteResponsePlan

update

Parent base class for filters and actions.

definitions:
  Action:
    additionalProperties: false
    description: The automation configuration to launch.
    properties:
      SsmAutomation:
        additionalProperties: false
        description: The configuration to use when starting the SSM automation document.
        properties:
          DocumentName:
            description: The document name to use when starting the SSM automation
              document.
            maxLength: 128
            type: string
          DocumentVersion:
            description: The version of the document to use when starting the SSM
              automation document.
            maxLength: 128
            type: string
          Parameters:
            description: The parameters to set when starting the SSM automation document.
            insertionOrder: false
            items:
              additionalProperties: false
              description: A parameter to set when starting the SSM automation document.
              properties:
                Key:
                  maxLength: 50
                  minLength: 1
                  type: string
                Values:
                  insertionOrder: true
                  items:
                    description: A value of the parameter to set when starting the
                      SSM automation document.
                    maxLength: 10000
                    type: string
                  maxItems: 10
                  minItems: 1
                  type: array
                  uniqueItems: true
              required:
              - Values
              - Key
              type: object
            maxItems: 200
            type: array
            uniqueItems: true
          RoleArn:
            description: The role ARN to use when starting the SSM automation document.
            maxLength: 1000
            pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
            type: string
          TargetAccount:
            description: The account type to use when starting the SSM automation
              document.
            enum:
            - IMPACTED_ACCOUNT
            - RESPONSE_PLAN_OWNER_ACCOUNT
            type: string
        required:
        - RoleArn
        - DocumentName
        type: object
    type: object
  ChatChannel:
    additionalProperties: false
    description: The chat channel configuration.
    properties:
      ChatbotSns:
        insertionOrder: true
        items:
          description: The ARN of the Chatbot SNS topic.
          maxLength: 1000
          pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
          type: string
        type: array
        uniqueItems: true
    type: object
  ChatbotSns:
    insertionOrder: true
    items:
      description: The ARN of the Chatbot SNS topic.
      maxLength: 1000
      pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
      type: string
    type: array
    uniqueItems: true
  IncidentTemplate:
    additionalProperties: false
    description: The incident template configuration.
    properties:
      DedupeString:
        description: The deduplication string.
        maxLength: 1000
        minLength: 1
        type: string
      Impact:
        description: The impact value.
        maximum: 5
        minimum: 1
        type: integer
      NotificationTargets:
        description: The list of notification targets.
        insertionOrder: false
        items:
          additionalProperties: false
          description: A notification target.
          properties:
            SnsTopicArn:
              description: The ARN of the Chatbot SNS topic.
              maxLength: 1000
              pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
              type: string
          type: object
        maxItems: 10
        type: array
      Summary:
        description: The summary string.
        maxLength: 4000
        minLength: 1
        type: string
      Title:
        description: The title string.
        maxLength: 200
        type: string
    required:
    - Title
    - Impact
    type: object
  NotificationTargetItem:
    additionalProperties: false
    description: A notification target.
    properties:
      SnsTopicArn:
        description: The ARN of the Chatbot SNS topic.
        maxLength: 1000
        pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
        type: string
    type: object
  SSMContact:
    description: The ARN of the contact.
    maxLength: 1000
    pattern: ^arn:aws(-(cn|us-gov))?:ssm-contacts:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
    type: string
  SnsArn:
    description: The ARN of the Chatbot SNS topic.
    maxLength: 1000
    pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
    type: string
  SsmAutomation:
    additionalProperties: false
    description: The configuration to use when starting the SSM automation document.
    properties:
      DocumentName:
        description: The document name to use when starting the SSM automation document.
        maxLength: 128
        type: string
      DocumentVersion:
        description: The version of the document to use when starting the SSM automation
          document.
        maxLength: 128
        type: string
      Parameters:
        description: The parameters to set when starting the SSM automation document.
        insertionOrder: false
        items:
          additionalProperties: false
          description: A parameter to set when starting the SSM automation document.
          properties:
            Key:
              maxLength: 50
              minLength: 1
              type: string
            Values:
              insertionOrder: true
              items:
                description: A value of the parameter to set when starting the SSM
                  automation document.
                maxLength: 10000
                type: string
              maxItems: 10
              minItems: 1
              type: array
              uniqueItems: true
          required:
          - Values
          - Key
          type: object
        maxItems: 200
        type: array
        uniqueItems: true
      RoleArn:
        description: The role ARN to use when starting the SSM automation document.
        maxLength: 1000
        pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
        type: string
      TargetAccount:
        description: The account type to use when starting the SSM automation document.
        enum:
        - IMPACTED_ACCOUNT
        - RESPONSE_PLAN_OWNER_ACCOUNT
        type: string
    required:
    - RoleArn
    - DocumentName
    type: object
  SsmParameter:
    additionalProperties: false
    description: A parameter to set when starting the SSM automation document.
    properties:
      Key:
        maxLength: 50
        minLength: 1
        type: string
      Values:
        insertionOrder: true
        items:
          description: A value of the parameter to set when starting the SSM automation
            document.
          maxLength: 10000
          type: string
        maxItems: 10
        minItems: 1
        type: array
        uniqueItems: true
    required:
    - Values
    - Key
    type: object
  SsmParameterValue:
    description: A value of the parameter to set when starting the SSM automation
      document.
    maxLength: 10000
    type: string
  Tag:
    additionalProperties: false
    description: A key-value pair to tag a resource.
    properties:
      Key:
        maxLength: 128
        minLength: 1
        pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
        type: string
      Value:
        maxLength: 256
        minLength: 1
        type: string
    required:
    - Value
    - Key
    type: object
properties:
  Actions:
    default: []
    description: The list of actions.
    insertionOrder: true
    items:
      additionalProperties: false
      description: The automation configuration to launch.
      properties:
        SsmAutomation:
          additionalProperties: false
          description: The configuration to use when starting the SSM automation document.
          properties:
            DocumentName:
              description: The document name to use when starting the SSM automation
                document.
              maxLength: 128
              type: string
            DocumentVersion:
              description: The version of the document to use when starting the SSM
                automation document.
              maxLength: 128
              type: string
            Parameters:
              description: The parameters to set when starting the SSM automation
                document.
              insertionOrder: false
              items:
                additionalProperties: false
                description: A parameter to set when starting the SSM automation document.
                properties:
                  Key:
                    maxLength: 50
                    minLength: 1
                    type: string
                  Values:
                    insertionOrder: true
                    items:
                      description: A value of the parameter to set when starting the
                        SSM automation document.
                      maxLength: 10000
                      type: string
                    maxItems: 10
                    minItems: 1
                    type: array
                    uniqueItems: true
                required:
                - Values
                - Key
                type: object
              maxItems: 200
              type: array
              uniqueItems: true
            RoleArn:
              description: The role ARN to use when starting the SSM automation document.
              maxLength: 1000
              pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
              type: string
            TargetAccount:
              description: The account type to use when starting the SSM automation
                document.
              enum:
              - IMPACTED_ACCOUNT
              - RESPONSE_PLAN_OWNER_ACCOUNT
              type: string
          required:
          - RoleArn
          - DocumentName
          type: object
      type: object
    maxItems: 1
    type: array
    uniqueItems: true
  ChatChannel:
    additionalProperties: false
    description: The chat channel configuration.
    properties:
      ChatbotSns:
        insertionOrder: true
        items:
          description: The ARN of the Chatbot SNS topic.
          maxLength: 1000
          pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
          type: string
        type: array
        uniqueItems: true
    type: object
  DisplayName:
    description: The display name of the response plan.
    maxLength: 200
    minLength: 1
    type: string
  Engagements:
    default: []
    description: The list of engagements to use.
    insertionOrder: false
    items:
      description: The ARN of the contact.
      maxLength: 1000
      pattern: ^arn:aws(-(cn|us-gov))?:ssm-contacts:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
      type: string
    maxItems: 5
    minItems: 1
    type: array
    uniqueItems: true
  IncidentTemplate:
    additionalProperties: false
    description: The incident template configuration.
    properties:
      DedupeString:
        description: The deduplication string.
        maxLength: 1000
        minLength: 1
        type: string
      Impact:
        description: The impact value.
        maximum: 5
        minimum: 1
        type: integer
      NotificationTargets:
        description: The list of notification targets.
        insertionOrder: false
        items:
          additionalProperties: false
          description: A notification target.
          properties:
            SnsTopicArn:
              description: The ARN of the Chatbot SNS topic.
              maxLength: 1000
              pattern: ^arn:aws(-(cn|us-gov))?:sns:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$
              type: string
          type: object
        maxItems: 10
        type: array
      Summary:
        description: The summary string.
        maxLength: 4000
        minLength: 1
        type: string
      Title:
        description: The title string.
        maxLength: 200
        type: string
    required:
    - Title
    - Impact
    type: object
  Tags:
    default: []
    description: The tags to apply to the response plan.
    insertionOrder: false
    items:
      additionalProperties: false
      description: A key-value pair to tag a resource.
      properties:
        Key:
          maxLength: 128
          minLength: 1
          pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
          type: string
        Value:
          maxLength: 256
          minLength: 1
          type: string
      required:
      - Value
      - Key
      type: object
    maxItems: 50
    minItems: 1
    type: array
    uniqueItems: true
  type:
    enum:
    - update

Permissions - ssm-incidents:UpdateResponsePlan, iam:PassRole, ssm-incidents:TagResource, ssm-incidents:UntagResource, ssm-incidents:ListTagsForResource