PUTDEPLOYMENTPARAMETER()`¶

About PutDeploymentParameter¶

Creates or updates a deployment parameter and is targeted by catalog and agreementId.

Method Signature¶

METHODS /AWS1/IF_MPD~PUTDEPLOYMENTPARAMETER
  IMPORTING
    !IV_CATALOG TYPE /AWS1/MPDCATALOG OPTIONAL
    !IV_PRODUCTID TYPE /AWS1/MPDRESOURCEID OPTIONAL
    !IV_AGREEMENTID TYPE /AWS1/MPDRESOURCEID OPTIONAL
    !IO_DEPLOYMENTPARAMETER TYPE REF TO /AWS1/CL_MPDDEPLOYMENTPARAMINP OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_MPDTAGSMAP_W=>TT_TAGSMAP OPTIONAL
    !IV_EXPIRATIONDATE TYPE /AWS1/MPDTIMESTAMP OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/MPDCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpdputdeploymentprm01
  RAISING
    /AWS1/CX_MPDACCESSDENIEDEX
    /AWS1/CX_MPDCONFLICTEXCEPTION
    /AWS1/CX_MPDINTERNALSERVEREX
    /AWS1/CX_MPDRESOURCENOTFOUNDEX
    /AWS1/CX_MPDSERVICEQUOTAEXCDEX
    /AWS1/CX_MPDTHROTTLINGEX
    /AWS1/CX_MPDVALIDATIONEX
    /AWS1/CX_MPDCLIENTEXC
    /AWS1/CX_MPDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_catalog` `TYPE /AWS1/MPDCATALOG` `/AWS1/MPDCATALOG`¶

The catalog related to the request. Fixed value: AWSMarketplace

`iv_productid` `TYPE /AWS1/MPDRESOURCEID` `/AWS1/MPDRESOURCEID`¶

The product for which AWS Marketplace will save secrets for the buyer’s account.

`iv_agreementid` `TYPE /AWS1/MPDRESOURCEID` `/AWS1/MPDRESOURCEID`¶

The unique identifier of the agreement.

`io_deploymentparameter` `TYPE REF TO /AWS1/CL_MPDDEPLOYMENTPARAMINP` `/AWS1/CL_MPDDEPLOYMENTPARAMINP`¶

The deployment parameter targeted to the acceptor of an agreement for which to create the AWS Secret Manager resource.

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_MPDTAGSMAP_W=>TT_TAGSMAP` `TT_TAGSMAP`¶

A map of key-value pairs, where each pair represents a tag saved to the resource. Tags will only be applied for create operations, and they'll be ignored if the resource already exists.

`iv_expirationdate` `TYPE /AWS1/MPDTIMESTAMP` `/AWS1/MPDTIMESTAMP`¶

The date when deployment parameters expire and are scheduled for deletion.

`iv_clienttoken` `TYPE /AWS1/MPDCLIENTTOKEN` `/AWS1/MPDCLIENTTOKEN`¶

The idempotency token for deployment parameters. A unique identifier for the new version.

This field is not required if you're calling using an AWS SDK. Otherwise, a clientToken must be provided with the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_mpdputdeploymentprm01` `/AWS1/CL_MPDPUTDEPLOYMENTPRM01`¶

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->putdeploymentparameter(
  io_deploymentparameter = new /aws1/cl_mpddeploymentparaminp(
    iv_name = |string|
    iv_secretstring = |string|
  )
  it_tags = VALUE /aws1/cl_mpdtagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_mpdtagsmap_w=>ts_tagsmap_maprow(
        key = |string|
        value = new /aws1/cl_mpdtagsmap_w( |string| )
      )
    )
  )
  iv_agreementid = |string|
  iv_catalog = |string|
  iv_clienttoken = |string|
  iv_expirationdate = '20150101000000.0000000'
  iv_productid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcearn = lo_result->get_resourcearn( ).
  lv_resourceid = lo_result->get_agreementid( ).
  lv_deploymentparameterreso = lo_result->get_deploymentparameterid( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Creating or updating a deployment parameter¶

The following example demonstrates creating or updating a deployment parameter named "ExampleDeploymentParameterName". The secret will be saved in the Buyer account associated with the passed agreementId, with the value set to the provided secretString. Note that the deployment parameter secretString can be passed in JSON string format, allowing json-key specific CloudFormation dynamic references from a single deployment parameter.

DATA(lo_result) = lo_client->putdeploymentparameter(
  io_deploymentparameter = new /aws1/cl_mpddeploymentparaminp(
    iv_name = |ExampleDeploymentParameterName|
    iv_secretstring = |{"apiKey": "helloWorldApiKey", "entityId": "fooBarEntityId"}|
  )
  iv_agreementid = |agmt-1234|
  iv_catalog = |AWSMarketplace|
  iv_clienttoken = |some-unique-uuid-between-32-and-64-characters|
  iv_productid = |product-1234|
).

Creating a simple deployment parameter, with tags and expiration.¶

The following example demonstrates creating a simple deployment parameter named "ExampleSimpleDeploymentParameterName". If multiple secrets are not required, the secretString may be provided in String format. The provided tags are only applied on resource creation and will be ignored if the operation results in an update. The API response includes the tags present on the resource after completion of the operation.

DATA(lo_result) = lo_client->putdeploymentparameter(
  io_deploymentparameter = new /aws1/cl_mpddeploymentparaminp(
    iv_name = |ExampleSimpleDeploymentParameterName|
    iv_secretstring = |MySimpleValue|
  )
  it_tags = VALUE /aws1/cl_mpdtagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_mpdtagsmap_w=>ts_tagsmap_maprow(
        key = |FooKey|
        value = new /aws1/cl_mpdtagsmap_w( |BarValue| )
      )
    )
    (
      VALUE /aws1/cl_mpdtagsmap_w=>ts_tagsmap_maprow(
        key = |HelloKey|
        value = new /aws1/cl_mpdtagsmap_w( |WorldValue| )
      )
    )
  )
  iv_agreementid = |agmt-1234|
  iv_catalog = |AWSMarketplace|
  iv_clienttoken = |some-unique-uuid-between-32-and-64-characters|
  iv_expirationdate = '20991118085246.3970000'
  iv_productid = |product-1234|
).

/AWS1/IF_MPD=>PUTDEPLOYMENTPARAMETER()¶