Skip to content

/AWS1/IF_DOD=>COPYDBCLUSTERSNAPSHOT()

About CopyDBClusterSnapshot

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

Method Signature

METHODS /AWS1/IF_DOD~COPYDBCLUSTERSNAPSHOT
  IMPORTING
    !IV_SOURCEDBCLUSTERSNAPSHOTID TYPE /AWS1/DODSTRING OPTIONAL
    !IV_TARGETDBCLUSTERSNAPSHOTID TYPE /AWS1/DODSTRING OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/DODSTRING OPTIONAL
    !IV_PRESIGNEDURL TYPE /AWS1/DODSTRING OPTIONAL
    !IV_COPYTAGS TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DODTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodcpydbclustsnaprslt
  RAISING
    /AWS1/CX_DODDBCLSTSNAPALREXF00
    /AWS1/CX_DODDBCLSTSNAPNOTFND00
    /AWS1/CX_DODINVDBCLSTSNAPSTA00
    /AWS1/CX_DODINVDBCLSTSTATEFA00
    /AWS1/CX_DODKMSKEYNOTACCIBLE00
    /AWS1/CX_DODSNAPQUOTAEXCDFAULT
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_sourcedbclustersnapshotid TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid cluster snapshot in the available state.

  • If the source cluster snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.

  • If the source cluster snapshot is in a different Amazon Web Services Region or owned by another Amazon Web Services account, specify the snapshot ARN.

Example: my-cluster-snapshot1

iv_targetdbclustersnapshotid TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Optional arguments:

iv_kmskeyid TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

iv_presignedurl TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

iv_copytags TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

it_tags TYPE /AWS1/CL_DODTAG=>TT_TAGLIST TT_TAGLIST

The tags to be assigned to the cluster snapshot.

RETURNING

oo_output TYPE REF TO /aws1/cl_dodcpydbclustsnaprslt /AWS1/CL_DODCPYDBCLUSTSNAPRSLT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->copydbclustersnapshot(
  it_tags = VALUE /aws1/cl_dodtag=>tt_taglist(
    (
      new /aws1/cl_dodtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_copytags = ABAP_TRUE
  iv_kmskeyid = |string|
  iv_presignedurl = |string|
  iv_sourcedbclustersnapshotid = |string|
  iv_targetdbclustersnapshotid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbclustersnapshot = lo_result->get_dbclustersnapshot( ).
  IF lo_dbclustersnapshot IS NOT INITIAL.
    LOOP AT lo_dbclustersnapshot->get_availabilityzones( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbclustersnapshot->get_dbclustersnapshotid( ).
    lv_string = lo_dbclustersnapshot->get_dbclusteridentifier( ).
    lv_tstamp = lo_dbclustersnapshot->get_snapshotcreatetime( ).
    lv_string = lo_dbclustersnapshot->get_engine( ).
    lv_string = lo_dbclustersnapshot->get_status( ).
    lv_integer = lo_dbclustersnapshot->get_port( ).
    lv_string = lo_dbclustersnapshot->get_vpcid( ).
    lv_tstamp = lo_dbclustersnapshot->get_clustercreatetime( ).
    lv_string = lo_dbclustersnapshot->get_masterusername( ).
    lv_string = lo_dbclustersnapshot->get_engineversion( ).
    lv_string = lo_dbclustersnapshot->get_snapshottype( ).
    lv_integer = lo_dbclustersnapshot->get_percentprogress( ).
    lv_boolean = lo_dbclustersnapshot->get_storageencrypted( ).
    lv_string = lo_dbclustersnapshot->get_kmskeyid( ).
    lv_string = lo_dbclustersnapshot->get_dbclustersnapshotarn( ).
    lv_string = lo_dbclustersnapshot->get_sourcedbclustersnaparn( ).
    lv_string = lo_dbclustersnapshot->get_storagetype( ).
  ENDIF.
ENDIF.