Skip to content

/AWS1/IF_NEP=>COPYDBCLUSTERSNAPSHOT()

About CopyDBClusterSnapshot

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

Method Signature

IMPORTING

Required arguments:

iv_sourcedbclustersnapshotid TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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

Constraints:

  • Must specify a valid system snapshot in the "available" state.

  • Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

iv_targetdbclustersnapshotid TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

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

Constraints:

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

  • 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/NEPSTRING /AWS1/NEPSTRING

The Amazon Amazon KMS key ID for an encrypted DB 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 DB cluster snapshot from your Amazon 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 DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

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

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

iv_presignedurl TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

Not currently supported.

iv_copytags TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL

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

it_tags TYPE /AWS1/CL_NEPTAG=>TT_TAGLIST TT_TAGLIST

The tags to assign to the new DB cluster snapshot copy.

RETURNING

oo_output TYPE REF TO /aws1/cl_nepcpydbclustsnaprslt /AWS1/CL_NEPCPYDBCLUSTSNAPRSLT

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->/aws1/if_nep~copydbclustersnapshot(
  it_tags = VALUE /aws1/cl_neptag=>tt_taglist(
    (
      new /aws1/cl_neptag(
        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_integer = lo_dbclustersnapshot->get_allocatedstorage( ).
    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_licensemodel( ).
    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_boolean = lo_dbclustersnapshot->get_iamdatabaseauthntctnenbd( ).
    lv_string = lo_dbclustersnapshot->get_storagetype( ).
  ENDIF.
ENDIF.