drs / Client / create_recovery_plan_step

create_recovery_plan_step

drs.Client.create_recovery_plan_step(**kwargs)

Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).

See also: AWS API Documentation

Request Syntax

response = client.create_recovery_plan_step(
    recoveryPlanArn='string',
    stepName='string',
    stepOrder=123,
    configuration={
        'serverStepConfiguration': {
            'servers': [
                {
                    'serverArn': 'string',
                    'impactLevel': 'CRITICAL'|'OPTIONAL'
                },
            ]
        },
        'waitStepConfiguration': {
            'waitDurationMinutes': 123
        }
    },
    clientToken='string'
)

Parameters:

• recoveryPlanArn (string) –

  [REQUIRED]

  The ARN of the Recovery Plan to add the step to.

• stepName (string) –

  [REQUIRED]

  The name of a Recovery Plan Step.

• stepOrder (integer) – The order of a step within a Recovery Plan (1-based).

• configuration (dict) –

  [REQUIRED]

  Type-specific configuration for a recovery plan step. Exactly one member must be set.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: serverStepConfiguration, waitStepConfiguration.

  • serverStepConfiguration (dict) –

    Configuration for a SERVER type step.

    • servers (list) – [REQUIRED]

      The list of servers to recover in this step.

      • (dict) –

        A server associated with a Recovery Plan Step.

        • serverArn (string) – [REQUIRED]

          The ARN of the source server.

        • impactLevel (string) –

          Defaults to CRITICAL if not specified.

  • waitStepConfiguration (dict) –

    Configuration for a WAIT type step.

    • waitDurationMinutes (integer) – [REQUIRED]

      The wait duration in minutes for a Wait type step.

• clientToken (string) –

  A unique string provided to ensure request idempotency.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlanStep': {
        'recoveryPlanStepArn': 'string',
        'stepOrder': 123,
        'stepName': 'string',
        'configuration': {
            'serverStepConfiguration': {
                'servers': [
                    {
                        'serverArn': 'string',
                        'impactLevel': 'CRITICAL'|'OPTIONAL'
                    },
                ]
            },
            'waitStepConfiguration': {
                'waitDurationMinutes': 123
            }
        },
        'createdAt': 'string',
        'updatedAt': 'string'
    }
}

Response Structure

• (dict) –

  • recoveryPlanStep (dict) –

    A Recovery Plan Step resource.

    • recoveryPlanStepArn (string) –

      The ARN of the Recovery Plan step.

    • stepOrder (integer) –

      The order of a step within a Recovery Plan (1-based).

    • stepName (string) –

      The name of a Recovery Plan Step.

    • configuration (dict) –

      Type-specific configuration for a recovery plan step. Exactly one member must be set.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: serverStepConfiguration, waitStepConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • serverStepConfiguration (dict) –

        Configuration for a SERVER type step.

        • servers (list) –

          The list of servers to recover in this step.

          • (dict) –

            A server associated with a Recovery Plan Step.

            • serverArn (string) –

              The ARN of the source server.

            • impactLevel (string) –

              Defaults to CRITICAL if not specified.

      • waitStepConfiguration (dict) –

        Configuration for a WAIT type step.

        • waitDurationMinutes (integer) –

          The wait duration in minutes for a Wait type step.

    • createdAt (string) –

      The timestamp when the step was created.

    • updatedAt (string) –

      The timestamp when the step was last updated.

Exceptions

• drs.Client.exceptions.ResourceNotFoundException

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ConflictException

• drs.Client.exceptions.ServiceQuotaExceededException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.AccessDeniedException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException