UPDATELIFECYCLEPOLICY()`¶

About UpdateLifecyclePolicy¶

Updates the specified lifecycle policy.

For more information about updating a policy, see Modify lifecycle policies.

Method Signature¶

METHODS /AWS1/IF_DLM~UPDATELIFECYCLEPOLICY
  IMPORTING
    !IV_POLICYID TYPE /AWS1/DLMPOLICYID OPTIONAL
    !IV_EXECUTIONROLEARN TYPE /AWS1/DLMEXECUTIONROLEARN OPTIONAL
    !IV_STATE TYPE /AWS1/DLMSETTBLPLYSTATEVALUES OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DLMPOLICYDESCRIPTION OPTIONAL
    !IO_POLICYDETAILS TYPE REF TO /AWS1/CL_DLMPOLICYDETAILS OPTIONAL
    !IV_CREATEINTERVAL TYPE /AWS1/DLMCREATEINTERVAL OPTIONAL
    !IV_RETAININTERVAL TYPE /AWS1/DLMRETAININTERVAL OPTIONAL
    !IV_COPYTAGS TYPE /AWS1/DLMCOPYTAGSNULLABLE OPTIONAL
    !IV_EXTENDDELETION TYPE /AWS1/DLMEXTENDDELETION OPTIONAL
    !IT_CROSSREGIONCOPYTARGETS TYPE /AWS1/CL_DLMCROSSREGIONCOPYTGT=>TT_CROSSREGIONCOPYTARGETLIST OPTIONAL
    !IO_EXCLUSIONS TYPE REF TO /AWS1/CL_DLMEXCLUSIONS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dlmupdatelcpolicyrsp
  RAISING
    /AWS1/CX_DLMINTERNALSERVEREX
    /AWS1/CX_DLMINVALIDREQUESTEX
    /AWS1/CX_DLMLIMITEXCEEDEDEX
    /AWS1/CX_DLMRESOURCENOTFOUNDEX
    /AWS1/CX_DLMCLIENTEXC
    /AWS1/CX_DLMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_policyid` `TYPE /AWS1/DLMPOLICYID` `/AWS1/DLMPOLICYID`¶

The identifier of the lifecycle policy.

Optional arguments:¶

`iv_executionrolearn` `TYPE /AWS1/DLMEXECUTIONROLEARN` `/AWS1/DLMEXECUTIONROLEARN`¶

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

`iv_state` `TYPE /AWS1/DLMSETTBLPLYSTATEVALUES` `/AWS1/DLMSETTBLPLYSTATEVALUES`¶

The desired activation state of the lifecycle policy after creation.

`iv_description` `TYPE /AWS1/DLMPOLICYDESCRIPTION` `/AWS1/DLMPOLICYDESCRIPTION`¶

A description of the lifecycle policy.

`io_policydetails` `TYPE REF TO /AWS1/CL_DLMPOLICYDETAILS` `/AWS1/CL_DLMPOLICYDETAILS`¶

The configuration of the lifecycle policy. You cannot update the policy type or the resource type.

`iv_createinterval` `TYPE /AWS1/DLMCREATEINTERVAL` `/AWS1/DLMCREATEINTERVAL`¶

[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.

`iv_retaininterval` `TYPE /AWS1/DLMRETAININTERVAL` `/AWS1/DLMRETAININTERVAL`¶

[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.

`iv_copytags` `TYPE /AWS1/DLMCOPYTAGSNULLABLE` `/AWS1/DLMCOPYTAGSNULLABLE`¶

[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.

`iv_extenddeletion` `TYPE /AWS1/DLMEXTENDDELETION` `/AWS1/DLMEXTENDDELETION`¶

[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

By default (ExtendDeletion=false):

If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

Default: false

`it_crossregioncopytargets` `TYPE /AWS1/CL_DLMCROSSREGIONCOPYTGT=>TT_CROSSREGIONCOPYTARGETLIST` `TT_CROSSREGIONCOPYTARGETLIST`¶

[Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

`io_exclusions` `TYPE REF TO /AWS1/CL_DLMEXCLUSIONS` `/AWS1/CL_DLMEXCLUSIONS`¶

[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dlmupdatelcpolicyrsp` `/AWS1/CL_DLMUPDATELCPOLICYRSP`¶

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->updatelifecyclepolicy(
  io_exclusions = new /aws1/cl_dlmexclusions(
    it_excludetags = VALUE /aws1/cl_dlmtag=>tt_excludetagslist(
      (
        new /aws1/cl_dlmtag(
          iv_key = |string|
          iv_value = |string|
        )
      )
    )
    it_excludevolumetypes = VALUE /aws1/cl_dlmexcludevoltypesl00=>tt_excludevolumetypeslist(
      ( new /aws1/cl_dlmexcludevoltypesl00( |string| ) )
    )
    iv_excludebootvolumes = ABAP_TRUE
  )
  io_policydetails = new /aws1/cl_dlmpolicydetails(
    io_eventsource = new /aws1/cl_dlmeventsource(
      io_parameters = new /aws1/cl_dlmeventparameters(
        it_snapshotowner = VALUE /aws1/cl_dlmsnapownerlist_w=>tt_snapshotownerlist(
          ( new /aws1/cl_dlmsnapownerlist_w( |string| ) )
        )
        iv_descriptionregex = |string|
        iv_eventtype = |string|
      )
      iv_type = |string|
    )
    io_exclusions = new /aws1/cl_dlmexclusions(
      it_excludetags = VALUE /aws1/cl_dlmtag=>tt_excludetagslist(
        (
          new /aws1/cl_dlmtag(
            iv_key = |string|
            iv_value = |string|
          )
        )
      )
      it_excludevolumetypes = VALUE /aws1/cl_dlmexcludevoltypesl00=>tt_excludevolumetypeslist(
        ( new /aws1/cl_dlmexcludevoltypesl00( |string| ) )
      )
      iv_excludebootvolumes = ABAP_TRUE
    )
    io_parameters = new /aws1/cl_dlmparameters(
      it_excludedatavolumetags = VALUE /aws1/cl_dlmtag=>tt_excludedatavolumetaglist(
        (
          new /aws1/cl_dlmtag(
            iv_key = |string|
            iv_value = |string|
          )
        )
      )
      iv_excludebootvolume = ABAP_TRUE
      iv_noreboot = ABAP_TRUE
    )
    it_actions = VALUE /aws1/cl_dlmaction=>tt_actionlist(
      (
        new /aws1/cl_dlmaction(
          it_crossregioncopy = VALUE /aws1/cl_dlmcrossregioncopyact=>tt_crossregioncopyactionlist(
            (
              new /aws1/cl_dlmcrossregioncopyact(
                io_encryptionconfiguration = new /aws1/cl_dlmencryptionconf(
                  iv_cmkarn = |string|
                  iv_encrypted = ABAP_TRUE
                )
                io_retainrule = new /aws1/cl_dlmcrossregioncprtnrl(
                  iv_interval = 123
                  iv_intervalunit = |string|
                )
                iv_target = |string|
              )
            )
          )
          iv_name = |string|
        )
      )
    )
    it_crossregioncopytargets = VALUE /aws1/cl_dlmcrossregioncopytgt=>tt_crossregioncopytargetlist(
      ( new /aws1/cl_dlmcrossregioncopytgt( |string| ) )
    )
    it_resourcelocations = VALUE /aws1/cl_dlmresourceloclist_w=>tt_resourcelocationlist(
      ( new /aws1/cl_dlmresourceloclist_w( |string| ) )
    )
    it_resourcetypes = VALUE /aws1/cl_dlmresrctypevalslst_w=>tt_resourcetypevalueslist(
      ( new /aws1/cl_dlmresrctypevalslst_w( |string| ) )
    )
    it_schedules = VALUE /aws1/cl_dlmschedule=>tt_schedulelist(
      (
        new /aws1/cl_dlmschedule(
          io_archiverule = new /aws1/cl_dlmarchiverule(
            io_retainrule = new /aws1/cl_dlmarchiveretainrule(
              io_retentionarchivetier = new /aws1/cl_dlmretarchivetier(
                iv_count = 123
                iv_interval = 123
                iv_intervalunit = |string|
              )
            )
          )
          io_createrule = new /aws1/cl_dlmcreaterule(
            it_scripts = VALUE /aws1/cl_dlmscript=>tt_scriptslist(
              (
                new /aws1/cl_dlmscript(
                  it_stages = VALUE /aws1/cl_dlmstageslist_w=>tt_stageslist(
                    ( new /aws1/cl_dlmstageslist_w( |string| ) )
                  )
                  iv_executeoponscriptfailure = ABAP_TRUE
                  iv_executionhandler = |string|
                  iv_executionhandlerservice = |string|
                  iv_executiontimeout = 123
                  iv_maximumretrycount = 123
                )
              )
            )
            it_times = VALUE /aws1/cl_dlmtimeslist_w=>tt_timeslist(
              ( new /aws1/cl_dlmtimeslist_w( |string| ) )
            )
            iv_cronexpression = |string|
            iv_interval = 123
            iv_intervalunit = |string|
            iv_location = |string|
          )
          io_deprecaterule = new /aws1/cl_dlmdeprecaterule(
            iv_count = 123
            iv_interval = 123
            iv_intervalunit = |string|
          )
          io_fastrestorerule = new /aws1/cl_dlmfastrestorerule(
            it_availabilityzoneids = VALUE /aws1/cl_dlmazidlist_w=>tt_availabilityzoneidlist(
              ( new /aws1/cl_dlmazidlist_w( |string| ) )
            )
            it_availabilityzones = VALUE /aws1/cl_dlmazlist_w=>tt_availabilityzonelist(
              ( new /aws1/cl_dlmazlist_w( |string| ) )
            )
            iv_count = 123
            iv_interval = 123
            iv_intervalunit = |string|
          )
          io_retainrule = new /aws1/cl_dlmretainrule(
            iv_count = 123
            iv_interval = 123
            iv_intervalunit = |string|
          )
          it_crossregioncopyrules = VALUE /aws1/cl_dlmcrossregioncopyrl=>tt_crossregioncopyrules(
            (
              new /aws1/cl_dlmcrossregioncopyrl(
                io_deprecaterule = new /aws1/cl_dlmcrossregioncpdep00(
                  iv_interval = 123
                  iv_intervalunit = |string|
                )
                io_retainrule = new /aws1/cl_dlmcrossregioncprtnrl(
                  iv_interval = 123
                  iv_intervalunit = |string|
                )
                iv_cmkarn = |string|
                iv_copytags = ABAP_TRUE
                iv_encrypted = ABAP_TRUE
                iv_target = |string|
                iv_targetregion = |string|
              )
            )
          )
          it_sharerules = VALUE /aws1/cl_dlmsharerule=>tt_sharerules(
            (
              new /aws1/cl_dlmsharerule(
                it_targetaccounts = VALUE /aws1/cl_dlmsharetgtacctlist_w=>tt_sharetargetaccountlist(
                  ( new /aws1/cl_dlmsharetgtacctlist_w( |string| ) )
                )
                iv_unshareinterval = 123
                iv_unshareintervalunit = |string|
              )
            )
          )
          it_tagstoadd = VALUE /aws1/cl_dlmtag=>tt_tagstoaddlist(
            (
              new /aws1/cl_dlmtag(
                iv_key = |string|
                iv_value = |string|
              )
            )
          )
          it_variabletags = VALUE /aws1/cl_dlmtag=>tt_variabletagslist(
            (
              new /aws1/cl_dlmtag(
                iv_key = |string|
                iv_value = |string|
              )
            )
          )
          iv_copytags = ABAP_TRUE
          iv_name = |string|
        )
      )
    )
    it_targettags = VALUE /aws1/cl_dlmtag=>tt_targettaglist(
      (
        new /aws1/cl_dlmtag(
          iv_key = |string|
          iv_value = |string|
        )
      )
    )
    iv_copytags = ABAP_TRUE
    iv_createinterval = 123
    iv_extenddeletion = ABAP_TRUE
    iv_policylanguage = |string|
    iv_policytype = |string|
    iv_resourcetype = |string|
    iv_retaininterval = 123
  )
  it_crossregioncopytargets = VALUE /aws1/cl_dlmcrossregioncopytgt=>tt_crossregioncopytargetlist(
    ( new /aws1/cl_dlmcrossregioncopytgt( |string| ) )
  )
  iv_copytags = ABAP_TRUE
  iv_createinterval = 123
  iv_description = |string|
  iv_executionrolearn = |string|
  iv_extenddeletion = ABAP_TRUE
  iv_policyid = |string|
  iv_retaininterval = 123
  iv_state = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_DLM=>UPDATELIFECYCLEPOLICY()¶

About UpdateLifecyclePolicy¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_policyid TYPE /AWS1/DLMPOLICYID /AWS1/DLMPOLICYID¶

Optional arguments:¶

iv_executionrolearn TYPE /AWS1/DLMEXECUTIONROLEARN /AWS1/DLMEXECUTIONROLEARN¶

iv_state TYPE /AWS1/DLMSETTBLPLYSTATEVALUES /AWS1/DLMSETTBLPLYSTATEVALUES¶

iv_description TYPE /AWS1/DLMPOLICYDESCRIPTION /AWS1/DLMPOLICYDESCRIPTION¶

io_policydetails TYPE REF TO /AWS1/CL_DLMPOLICYDETAILS /AWS1/CL_DLMPOLICYDETAILS¶

iv_createinterval TYPE /AWS1/DLMCREATEINTERVAL /AWS1/DLMCREATEINTERVAL¶

iv_retaininterval TYPE /AWS1/DLMRETAININTERVAL /AWS1/DLMRETAININTERVAL¶

iv_copytags TYPE /AWS1/DLMCOPYTAGSNULLABLE /AWS1/DLMCOPYTAGSNULLABLE¶

iv_extenddeletion TYPE /AWS1/DLMEXTENDDELETION /AWS1/DLMEXTENDDELETION¶

it_crossregioncopytargets TYPE /AWS1/CL_DLMCROSSREGIONCOPYTGT=>TT_CROSSREGIONCOPYTARGETLIST TT_CROSSREGIONCOPYTARGETLIST¶

io_exclusions TYPE REF TO /AWS1/CL_DLMEXCLUSIONS /AWS1/CL_DLMEXCLUSIONS¶