UPDATECONSTRAINT()`¶

About UpdateConstraint¶

Updates the specified constraint.

Method Signature¶

METHODS /AWS1/IF_SCG~UPDATECONSTRAINT
  IMPORTING
    !IV_ACCEPTLANGUAGE TYPE /AWS1/SCGACCEPTLANGUAGE OPTIONAL
    !IV_ID TYPE /AWS1/SCGID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SCGCONSTRAINTDESCRIPTION OPTIONAL
    !IV_PARAMETERS TYPE /AWS1/SCGCONSTRAINTPARAMETERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_scgupdcnstrntoutput
  RAISING
    /AWS1/CX_SCGINVALIDPARAMSEX
    /AWS1/CX_SCGRESOURCENOTFOUNDEX
    /AWS1/CX_SCGCLIENTEXC
    /AWS1/CX_SCGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_id` `TYPE /AWS1/SCGID` `/AWS1/SCGID`¶

The identifier of the constraint.

Optional arguments:¶

`iv_acceptlanguage` `TYPE /AWS1/SCGACCEPTLANGUAGE` `/AWS1/SCGACCEPTLANGUAGE`¶

The language code.

jp - Japanese

zh - Chinese

`iv_description` `TYPE /AWS1/SCGCONSTRAINTDESCRIPTION` `/AWS1/SCGCONSTRAINTDESCRIPTION`¶

The updated description of the constraint.

`iv_parameters` `TYPE /AWS1/SCGCONSTRAINTPARAMETERS` `/AWS1/SCGCONSTRAINTPARAMETERS`¶

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_scgupdcnstrntoutput` `/AWS1/CL_SCGUPDCNSTRNTOUTPUT`¶

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->updateconstraint(
  iv_acceptlanguage = |string|
  iv_description = |string|
  iv_id = |string|
  iv_parameters = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_constraintdetail = lo_result->get_constraintdetail( ).
  IF lo_constraintdetail IS NOT INITIAL.
    lv_id = lo_constraintdetail->get_constraintid( ).
    lv_constrainttype = lo_constraintdetail->get_type( ).
    lv_constraintdescription = lo_constraintdetail->get_description( ).
    lv_accountid = lo_constraintdetail->get_owner( ).
    lv_id = lo_constraintdetail->get_productid( ).
    lv_id = lo_constraintdetail->get_portfolioid( ).
  ENDIF.
  lv_constraintparameters = lo_result->get_constraintparameters( ).
  lv_status = lo_result->get_status( ).
ENDIF.

/AWS1/IF_SCG=>UPDATECONSTRAINT()¶