/AWS1/IF_RDS=>RESTOREDBCLUSTTOPOINTINTIME()¶
About RestoreDBClusterToPointInTime¶
Restores a DB cluster to an arbitrary point in time. Users can restore to any point
in time before LatestRestorableTime for up to
BackupRetentionPeriod days. The target DB cluster is created from the
source DB cluster with the same configuration as the original DB cluster, except that
the new DB cluster is created with the default DB security group. Unless the
RestoreType is set to copy-on-write, the restore may occur in a
different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores
the DB cluster depends on the AZs in the specified subnet group.
For Aurora, this operation only restores the DB cluster, not the DB instances for that DB
cluster. You must invoke the CreateDBInstance operation to create DB
instances for the restored DB cluster, specifying the identifier of the restored DB
cluster in DBClusterIdentifier. You can create DB instances only after
the RestoreDBClusterToPointInTime operation has completed and the DB
cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Method Signature¶
METHODS /AWS1/IF_RDS~RESTOREDBCLUSTTOPOINTINTIME
IMPORTING
!IV_DBCLUSTERIDENTIFIER TYPE /AWS1/RDSSTRING OPTIONAL
!IV_RESTORETYPE TYPE /AWS1/RDSSTRING OPTIONAL
!IV_SOURCEDBCLUSTERIDENTIFIER TYPE /AWS1/RDSSTRING OPTIONAL
!IV_RESTORETOTIME TYPE /AWS1/RDSTSTAMP OPTIONAL
!IV_USELATESTRESTORABLETIME TYPE /AWS1/RDSBOOLEAN OPTIONAL
!IV_PORT TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
!IV_DBSUBNETGROUPNAME TYPE /AWS1/RDSSTRING OPTIONAL
!IV_OPTIONGROUPNAME TYPE /AWS1/RDSSTRING OPTIONAL
!IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_RDSVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST OPTIONAL
!IT_TAGS TYPE /AWS1/CL_RDSTAG=>TT_TAGLIST OPTIONAL
!IV_KMSKEYID TYPE /AWS1/RDSSTRING OPTIONAL
!IV_ENBIAMDATABASEAUTHNTCTN TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
!IV_BACKTRACKWINDOW TYPE /AWS1/RDSLONGOPTIONAL OPTIONAL
!IT_ENABLECLOUDWATCHLOGSEXP TYPE /AWS1/CL_RDSLOGTYPELIST_W=>TT_LOGTYPELIST OPTIONAL
!IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/RDSSTRING OPTIONAL
!IV_DELETIONPROTECTION TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
!IV_COPYTAGSTOSNAPSHOT TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
!IV_DOMAIN TYPE /AWS1/RDSSTRING OPTIONAL
!IV_DOMAINIAMROLENAME TYPE /AWS1/RDSSTRING OPTIONAL
!IV_DBCLUSTERINSTANCECLASS TYPE /AWS1/RDSSTRING OPTIONAL
!IV_STORAGETYPE TYPE /AWS1/RDSSTRING OPTIONAL
!IV_PUBLICLYACCESSIBLE TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
!IV_IOPS TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
!IV_NETWORKTYPE TYPE /AWS1/RDSSTRING OPTIONAL
!IV_SOURCEDBCLUSTERRESOURCEID TYPE /AWS1/RDSSTRING OPTIONAL
!IO_SERVERLESSV2SCALINGCONF TYPE REF TO /AWS1/CL_RDSSERVERLESSV2SCAC00 OPTIONAL
!IO_SCALINGCONFIGURATION TYPE REF TO /AWS1/CL_RDSSCALINGCONF OPTIONAL
!IV_ENGINEMODE TYPE /AWS1/RDSSTRING OPTIONAL
!IO_RDSCUSTOMCLUSTERCONF TYPE REF TO /AWS1/CL_RDSRDSCUSTOMCLUSTCONF OPTIONAL
!IV_MONITORINGINTERVAL TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
!IV_MONITORINGROLEARN TYPE /AWS1/RDSSTRING OPTIONAL
!IV_ENABLEPERFORMANCEINSIGHTS TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
!IV_PERFORMANCEINSIGHTSKMSK00 TYPE /AWS1/RDSSTRING OPTIONAL
!IV_PERFORMANCEINSIGHTSRETPER TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
!IV_ENGINELIFECYCLESUPPORT TYPE /AWS1/RDSSTRING OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdsrestoredbclsttop01
RAISING
/AWS1/CX_RDSDBCLSTALREXFAULT
/AWS1/CX_RDSDBCLSTAUTOMATEDB01
/AWS1/CX_RDSDBCLUSTNOTFNDFAULT
/AWS1/CX_RDSDBCLSTPRMGRNOTFN00
/AWS1/CX_RDSDBCLSTQUOTAEXCDF00
/AWS1/CX_RDSDBCLSTSNAPNOTFND00
/AWS1/CX_RDSDBSNETGRNOTFNDFA00
/AWS1/CX_RDSDOMNOTFOUNDFAULT
/AWS1/CX_RDSINSUFFICIENTDBCL00
/AWS1/CX_RDSINSUFFICIENTDBIN00
/AWS1/CX_RDSINSUFFICIENTSTRG00
/AWS1/CX_RDSINVDBCLSTSNAPSTA00
/AWS1/CX_RDSINVDBCLSTSTATEFA00
/AWS1/CX_RDSINVDBSNAPSTATEFA00
/AWS1/CX_RDSINVRESTOREFAULT
/AWS1/CX_RDSINVALIDSUBNET
/AWS1/CX_RDSINVVPCNETWORKSTA00
/AWS1/CX_RDSKMSKEYNOTACCIBLE00
/AWS1/CX_RDSNETWORKTYPENOTSU00
/AWS1/CX_RDSOPTIONGRNOTFNDFA00
/AWS1/CX_RDSSTRGQUOTAEXCDFAULT
/AWS1/CX_RDSSTRGTYPENOTSUPPE00
/AWS1/CX_RDSCLIENTEXC
/AWS1/CX_RDSSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_dbclusteridentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Optional arguments:¶
iv_restoretype TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The type of restore to be performed. You can specify one of the following values:
full-copy- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write- The new DB cluster is restored as a clone of the source DB cluster.If you don't specify a
RestoreTypevalue, then the new DB cluster is restored as a full copy of the source DB cluster.Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_sourcedbclusteridentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_restoretotime TYPE /AWS1/RDSTSTAMP /AWS1/RDSTSTAMP¶
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if
UseLatestRestorableTimeparameter isn't providedCan't be specified if the
UseLatestRestorableTimeparameter is enabledCan't be specified if the
RestoreTypeparameter iscopy-on-writeExample:
2015-03-07T23:45:00ZValid for: Aurora DB clusters and Multi-AZ DB clusters
iv_uselatestrestorabletime TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN¶
Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if
RestoreToTimeparameter is provided.Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_port TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL¶
The port number on which the new DB cluster accepts connections.
Constraints: A value from
1150-65535.Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_dbsubnetgroupname TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example:
mydbsubnetgroupValid for: Aurora DB clusters and Multi-AZ DB clusters
iv_optiongroupname TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
it_vpcsecuritygroupids TYPE /AWS1/CL_RDSVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST¶
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
it_tags TYPE /AWS1/CL_RDSTAG=>TT_TAGLIST TT_TAGLIST¶
Tags
iv_kmskeyid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyIdparameter.If you don't specify a value for the
KmsKeyIdparameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If
DBClusterIdentifierrefers to a DB cluster that isn't encrypted, then the restore request is rejected.Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_enbiamdatabaseauthntctn TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL¶
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_backtrackwindow TYPE /AWS1/RDSLONGOPTIONAL /AWS1/RDSLONGOPTIONAL¶
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
it_enablecloudwatchlogsexp TYPE /AWS1/CL_RDSLOGTYPELIST_W=>TT_LOGTYPELIST TT_LOGTYPELIST¶
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are
error,general,slowquery, andiam-db-auth-error.RDS for PostgreSQL
Possible values are
postgresql,upgrade, andiam-db-auth-error.Aurora MySQL
Possible values are
audit,error,general,instance,slowquery, andiam-db-auth-error.Aurora PostgreSQL
Possible value are
instance,postgresql, andiam-db-auth-error.For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_dbclusterparamgroupname TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The name of the custom DB cluster parameter group to associate with this DB cluster.
If the
DBClusterParameterGroupNameparameter is omitted, the default DB cluster parameter group for the specified engine is used.Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_deletionprotection TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL¶
Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_copytagstosnapshot TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL¶
Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_domain TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
iv_domainiamrolename TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
iv_dbclusterinstanceclass TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
iv_storagetype TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the
Iopsparameter is required.Valid Values:
aurora,aurora-iopt1(Aurora DB clusters);io1(Multi-AZ DB clusters)Default:
aurora(Aurora DB clusters);io1(Multi-AZ DB clusters)Valid for: Aurora DB clusters and Multi-AZ DB clusters
iv_publiclyaccessible TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL¶
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupNameis specified.If
DBSubnetGroupNameisn't specified, andPubliclyAccessibleisn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If
DBSubnetGroupNameis specified, andPubliclyAccessibleisn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
iv_iops TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL¶
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
iv_networktype TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The network type of the DB cluster.
Valid Values:
IPV4
DUALThe network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
iv_sourcedbclusterresourceid TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The resource ID of the source DB cluster from which to restore.
io_serverlessv2scalingconf TYPE REF TO /AWS1/CL_RDSSERVERLESSV2SCAC00 /AWS1/CL_RDSSERVERLESSV2SCAC00¶
ServerlessV2ScalingConfiguration
io_scalingconfiguration TYPE REF TO /AWS1/CL_RDSSCALINGCONF /AWS1/CL_RDSSCALINGCONF¶
For DB clusters in
serverlessDB engine mode, the scaling properties of the DB cluster.Valid for: Aurora DB clusters only
iv_enginemode TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The engine mode of the new cluster. Specify
provisionedorserverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine modeserverless.Valid for: Aurora DB clusters only
io_rdscustomclusterconf TYPE REF TO /AWS1/CL_RDSRDSCUSTOMCLUSTCONF /AWS1/CL_RDSRDSCUSTOMCLUSTCONF¶
Reserved for future use.
iv_monitoringinterval TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL¶
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify
0.If
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than0.Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60Default:
0
iv_monitoringrolearn TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess.If
MonitoringIntervalis set to a value other than0, supply aMonitoringRoleArnvalue.
iv_enableperformanceinsights TYPE /AWS1/RDSBOOLEANOPTIONAL /AWS1/RDSBOOLEANOPTIONAL¶
Specifies whether to turn on Performance Insights for the DB cluster.
iv_performanceinsightskmsk00 TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for
PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
iv_performanceinsightsretper TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL¶
The number of days to retain Performance Insights data.
Valid Values:
7month * 31, where month is a number of months from 1-23. Examples:
93(3 months * 31),341(11 months * 31),589(19 months * 31)
731Default:
7daysIf you specify a retention period that isn't valid, such as
94, Amazon RDS issues an error.
iv_enginelifecyclesupport TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The life cycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabledDefault:
open-source-rds-extended-support
RETURNING¶
oo_output TYPE REF TO /aws1/cl_rdsrestoredbclsttop01 /AWS1/CL_RDSRESTOREDBCLSTTOP01¶
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->restoredbclusttopointintime(
io_rdscustomclusterconf = new /aws1/cl_rdsrdscustomclustconf(
iv_interconnectsubnetid = |string|
iv_replicamode = |string|
iv_tgwmulticastdomainid = |string|
)
io_scalingconfiguration = new /aws1/cl_rdsscalingconf(
iv_autopause = ABAP_TRUE
iv_maxcapacity = 123
iv_mincapacity = 123
iv_secondsbeforetimeout = 123
iv_secondsuntilautopause = 123
iv_timeoutaction = |string|
)
io_serverlessv2scalingconf = new /aws1/cl_rdsserverlessv2scac00(
iv_maxcapacity = '0.1'
iv_mincapacity = '0.1'
iv_secondsuntilautopause = 123
)
it_enablecloudwatchlogsexp = VALUE /aws1/cl_rdslogtypelist_w=>tt_logtypelist(
( new /aws1/cl_rdslogtypelist_w( |string| ) )
)
it_tags = VALUE /aws1/cl_rdstag=>tt_taglist(
(
new /aws1/cl_rdstag(
iv_key = |string|
iv_value = |string|
)
)
)
it_vpcsecuritygroupids = VALUE /aws1/cl_rdsvpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
( new /aws1/cl_rdsvpcsecgrpidlist_w( |string| ) )
)
iv_backtrackwindow = 123
iv_copytagstosnapshot = ABAP_TRUE
iv_dbclusteridentifier = |string|
iv_dbclusterinstanceclass = |string|
iv_dbclusterparamgroupname = |string|
iv_dbsubnetgroupname = |string|
iv_deletionprotection = ABAP_TRUE
iv_domain = |string|
iv_domainiamrolename = |string|
iv_enableperformanceinsights = ABAP_TRUE
iv_enbiamdatabaseauthntctn = ABAP_TRUE
iv_enginelifecyclesupport = |string|
iv_enginemode = |string|
iv_iops = 123
iv_kmskeyid = |string|
iv_monitoringinterval = 123
iv_monitoringrolearn = |string|
iv_networktype = |string|
iv_optiongroupname = |string|
iv_performanceinsightskmsk00 = |string|
iv_performanceinsightsretper = 123
iv_port = 123
iv_publiclyaccessible = ABAP_TRUE
iv_restoretotime = '20150101000000.0000000'
iv_restoretype = |string|
iv_sourcedbclusteridentifier = |string|
iv_sourcedbclusterresourceid = |string|
iv_storagetype = |string|
iv_uselatestrestorabletime = ABAP_TRUE
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_dbcluster = lo_result->get_dbcluster( ).
IF lo_dbcluster IS NOT INITIAL.
lv_integeroptional = lo_dbcluster->get_allocatedstorage( ).
LOOP AT lo_dbcluster->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_integeroptional = lo_dbcluster->get_backupretentionperiod( ).
lv_string = lo_dbcluster->get_charactersetname( ).
lv_string = lo_dbcluster->get_databasename( ).
lv_string = lo_dbcluster->get_dbclusteridentifier( ).
lv_string = lo_dbcluster->get_dbclusterparametergroup( ).
lv_string = lo_dbcluster->get_dbsubnetgroup( ).
lv_string = lo_dbcluster->get_status( ).
lv_string = lo_dbcluster->get_percentprogress( ).
lv_tstamp = lo_dbcluster->get_earliestrestorabletime( ).
lv_string = lo_dbcluster->get_endpoint( ).
lv_string = lo_dbcluster->get_readerendpoint( ).
LOOP AT lo_dbcluster->get_customendpoints( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_string = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
lv_booleanoptional = lo_dbcluster->get_multiaz( ).
lv_string = lo_dbcluster->get_engine( ).
lv_string = lo_dbcluster->get_engineversion( ).
lv_tstamp = lo_dbcluster->get_latestrestorabletime( ).
lv_integeroptional = lo_dbcluster->get_port( ).
lv_string = lo_dbcluster->get_masterusername( ).
LOOP AT lo_dbcluster->get_dbclustoptiongrpmember00( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_string = lo_row_5->get_dbclusteroptiongroupname( ).
lv_string = lo_row_5->get_status( ).
ENDIF.
ENDLOOP.
lv_string = lo_dbcluster->get_preferredbackupwindow( ).
lv_string = lo_dbcluster->get_preferredmaintenancewi00( ).
lv_string = lo_dbcluster->get_replsourceidentifier( ).
LOOP AT lo_dbcluster->get_readreplicaidentifiers( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_string = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_dbcluster->get_statusinfos( ) into lo_row_8.
lo_row_9 = lo_row_8.
IF lo_row_9 IS NOT INITIAL.
lv_string = lo_row_9->get_statustype( ).
lv_boolean = lo_row_9->get_normal( ).
lv_string = lo_row_9->get_status( ).
lv_string = lo_row_9->get_message( ).
ENDIF.
ENDLOOP.
LOOP AT lo_dbcluster->get_dbclustermembers( ) into lo_row_10.
lo_row_11 = lo_row_10.
IF lo_row_11 IS NOT INITIAL.
lv_string = lo_row_11->get_dbinstanceidentifier( ).
lv_boolean = lo_row_11->get_isclusterwriter( ).
lv_string = lo_row_11->get_dbclustparamgroupstatus( ).
lv_integeroptional = lo_row_11->get_promotiontier( ).
ENDIF.
ENDLOOP.
LOOP AT lo_dbcluster->get_vpcsecuritygroups( ) into lo_row_12.
lo_row_13 = lo_row_12.
IF lo_row_13 IS NOT INITIAL.
lv_string = lo_row_13->get_vpcsecuritygroupid( ).
lv_string = lo_row_13->get_status( ).
ENDIF.
ENDLOOP.
lv_string = lo_dbcluster->get_hostedzoneid( ).
lv_boolean = lo_dbcluster->get_storageencrypted( ).
lv_string = lo_dbcluster->get_kmskeyid( ).
lv_string = lo_dbcluster->get_dbclusterresourceid( ).
lv_string = lo_dbcluster->get_dbclusterarn( ).
LOOP AT lo_dbcluster->get_associatedroles( ) into lo_row_14.
lo_row_15 = lo_row_14.
IF lo_row_15 IS NOT INITIAL.
lv_string = lo_row_15->get_rolearn( ).
lv_string = lo_row_15->get_status( ).
lv_string = lo_row_15->get_featurename( ).
ENDIF.
ENDLOOP.
lv_booleanoptional = lo_dbcluster->get_iamdatabaseauthntctnenbd( ).
lv_string = lo_dbcluster->get_clonegroupid( ).
lv_tstamp = lo_dbcluster->get_clustercreatetime( ).
lv_tstamp = lo_dbcluster->get_earliestbacktracktime( ).
lv_longoptional = lo_dbcluster->get_backtrackwindow( ).
lv_longoptional = lo_dbcluster->get_backtrackconsumedchang00( ).
LOOP AT lo_dbcluster->get_enabledcloudwatchlogsexp( ) into lo_row_16.
lo_row_17 = lo_row_16.
IF lo_row_17 IS NOT INITIAL.
lv_string = lo_row_17->get_value( ).
ENDIF.
ENDLOOP.
lv_integeroptional = lo_dbcluster->get_capacity( ).
lo_clusterpendingmodifiedv = lo_dbcluster->get_pendingmodifiedvalues( ).
IF lo_clusterpendingmodifiedv IS NOT INITIAL.
lo_pendingcloudwatchlogsex = lo_clusterpendingmodifiedv->get_pendingcloudwatchlogsexp( ).
IF lo_pendingcloudwatchlogsex IS NOT INITIAL.
LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_16.
lo_row_17 = lo_row_16.
IF lo_row_17 IS NOT INITIAL.
lv_string = lo_row_17->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_16.
lo_row_17 = lo_row_16.
IF lo_row_17 IS NOT INITIAL.
lv_string = lo_row_17->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
lv_string = lo_clusterpendingmodifiedv->get_dbclusteridentifier( ).
lv_sensitivestring = lo_clusterpendingmodifiedv->get_masteruserpassword( ).
lv_booleanoptional = lo_clusterpendingmodifiedv->get_iamdatabaseauthntctnenbd( ).
lv_string = lo_clusterpendingmodifiedv->get_engineversion( ).
lv_integeroptional = lo_clusterpendingmodifiedv->get_backupretentionperiod( ).
lv_string = lo_clusterpendingmodifiedv->get_storagetype( ).
lv_integeroptional = lo_clusterpendingmodifiedv->get_allocatedstorage( ).
lo_rdscustomclusterconfigu = lo_clusterpendingmodifiedv->get_rdscustomclusterconf( ).
IF lo_rdscustomclusterconfigu IS NOT INITIAL.
lv_string = lo_rdscustomclusterconfigu->get_interconnectsubnetid( ).
lv_string = lo_rdscustomclusterconfigu->get_tgwmulticastdomainid( ).
lv_replicamode = lo_rdscustomclusterconfigu->get_replicamode( ).
ENDIF.
lv_integeroptional = lo_clusterpendingmodifiedv->get_iops( ).
lo_certificatedetails = lo_clusterpendingmodifiedv->get_certificatedetails( ).
IF lo_certificatedetails IS NOT INITIAL.
lv_string = lo_certificatedetails->get_caidentifier( ).
lv_tstamp = lo_certificatedetails->get_validtill( ).
ENDIF.
ENDIF.
lv_string = lo_dbcluster->get_enginemode( ).
lo_scalingconfigurationinf = lo_dbcluster->get_scalingconfigurationinfo( ).
IF lo_scalingconfigurationinf IS NOT INITIAL.
lv_integeroptional = lo_scalingconfigurationinf->get_mincapacity( ).
lv_integeroptional = lo_scalingconfigurationinf->get_maxcapacity( ).
lv_booleanoptional = lo_scalingconfigurationinf->get_autopause( ).
lv_integeroptional = lo_scalingconfigurationinf->get_secondsuntilautopause( ).
lv_string = lo_scalingconfigurationinf->get_timeoutaction( ).
lv_integeroptional = lo_scalingconfigurationinf->get_secondsbeforetimeout( ).
ENDIF.
lo_rdscustomclusterconfigu = lo_dbcluster->get_rdscustomclusterconf( ).
IF lo_rdscustomclusterconfigu IS NOT INITIAL.
lv_string = lo_rdscustomclusterconfigu->get_interconnectsubnetid( ).
lv_string = lo_rdscustomclusterconfigu->get_tgwmulticastdomainid( ).
lv_replicamode = lo_rdscustomclusterconfigu->get_replicamode( ).
ENDIF.
lv_string = lo_dbcluster->get_dbclusterinstanceclass( ).
lv_string = lo_dbcluster->get_storagetype( ).
lv_integeroptional = lo_dbcluster->get_iops( ).
lv_integeroptional = lo_dbcluster->get_storagethroughput( ).
lv_tstamp = lo_dbcluster->get_iooptimizednextalwedmo00( ).
lv_booleanoptional = lo_dbcluster->get_publiclyaccessible( ).
lv_boolean = lo_dbcluster->get_autominorversionupgrade( ).
lv_booleanoptional = lo_dbcluster->get_deletionprotection( ).
lv_booleanoptional = lo_dbcluster->get_httpendpointenabled( ).
lv_activitystreammode = lo_dbcluster->get_activitystreammode( ).
lv_activitystreamstatus = lo_dbcluster->get_activitystreamstatus( ).
lv_string = lo_dbcluster->get_activitystreamkmskeyid( ).
lv_string = lo_dbcluster->get_activitystrmkinesisstr00( ).
lv_booleanoptional = lo_dbcluster->get_copytagstosnapshot( ).
lv_booleanoptional = lo_dbcluster->get_crossaccountclone( ).
LOOP AT lo_dbcluster->get_domainmemberships( ) into lo_row_18.
lo_row_19 = lo_row_18.
IF lo_row_19 IS NOT INITIAL.
lv_string = lo_row_19->get_domain( ).
lv_string = lo_row_19->get_status( ).
lv_string = lo_row_19->get_fqdn( ).
lv_string = lo_row_19->get_iamrolename( ).
lv_string = lo_row_19->get_ou( ).
lv_string = lo_row_19->get_authsecretarn( ).
LOOP AT lo_row_19->get_dnsips( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_string = lo_row_3->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDLOOP.
LOOP AT lo_dbcluster->get_taglist( ) into lo_row_20.
lo_row_21 = lo_row_20.
IF lo_row_21 IS NOT INITIAL.
lv_string = lo_row_21->get_key( ).
lv_string = lo_row_21->get_value( ).
ENDIF.
ENDLOOP.
lv_globalclusteridentifier = lo_dbcluster->get_globalclusteridentifier( ).
lv_writeforwardingstatus = lo_dbcluster->get_glbwriteforwardingstatus( ).
lv_booleanoptional = lo_dbcluster->get_glbwriteforwardingreqed( ).
lv_string = lo_dbcluster->get_networktype( ).
lv_tstamp = lo_dbcluster->get_automaticrestarttime( ).
lo_serverlessv2scalingconf = lo_dbcluster->get_serverlessv2scalingconf( ).
IF lo_serverlessv2scalingconf IS NOT INITIAL.
lv_doubleoptional = lo_serverlessv2scalingconf->get_mincapacity( ).
lv_doubleoptional = lo_serverlessv2scalingconf->get_maxcapacity( ).
lv_integeroptional = lo_serverlessv2scalingconf->get_secondsuntilautopause( ).
ENDIF.
lv_string = lo_dbcluster->get_serverlessv2pltfversion( ).
lv_integeroptional = lo_dbcluster->get_monitoringinterval( ).
lv_string = lo_dbcluster->get_monitoringrolearn( ).
lv_databaseinsightsmode = lo_dbcluster->get_databaseinsightsmode( ).
lv_booleanoptional = lo_dbcluster->get_performanceinsightsenbd( ).
lv_string = lo_dbcluster->get_performanceinsightskms00( ).
lv_integeroptional = lo_dbcluster->get_performanceinsightsret00( ).
lv_string = lo_dbcluster->get_dbsystemid( ).
lo_masterusersecret = lo_dbcluster->get_masterusersecret( ).
IF lo_masterusersecret IS NOT INITIAL.
lv_string = lo_masterusersecret->get_secretarn( ).
lv_string = lo_masterusersecret->get_secretstatus( ).
lv_string = lo_masterusersecret->get_kmskeyid( ).
ENDIF.
lv_localwriteforwardingsta = lo_dbcluster->get_localwriteforwardingstat( ).
lv_string = lo_dbcluster->get_awsbackuprecpointarn( ).
lo_limitlessdatabase = lo_dbcluster->get_limitlessdatabase( ).
IF lo_limitlessdatabase IS NOT INITIAL.
lv_limitlessdatabasestatus = lo_limitlessdatabase->get_status( ).
lv_doubleoptional = lo_limitlessdatabase->get_minrequiredacu( ).
ENDIF.
lv_clusterscalabilitytype = lo_dbcluster->get_clusterscalabilitytype( ).
lo_certificatedetails = lo_dbcluster->get_certificatedetails( ).
IF lo_certificatedetails IS NOT INITIAL.
lv_string = lo_certificatedetails->get_caidentifier( ).
lv_tstamp = lo_certificatedetails->get_validtill( ).
ENDIF.
lv_string = lo_dbcluster->get_enginelifecyclesupport( ).
ENDIF.
ENDIF.
To restore a DB cluster to a specified time¶
The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.
DATA(lo_result) = lo_client->restoredbclusttopointintime(
iv_dbclusteridentifier = |sample-cluster-clone|
iv_restoretype = |copy-on-write|
iv_sourcedbclusteridentifier = |database-4|
iv_uselatestrestorabletime = ABAP_TRUE
).