PUTRESOURCEPOLICY()`¶

About PutResourcePolicy¶

Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

Method Signature¶

METHODS /AWS1/IF_SSM~PUTRESOURCEPOLICY
  IMPORTING
    !IV_RESOURCEARN TYPE /AWS1/SSMRESOURCEARNSTRING OPTIONAL
    !IV_POLICY TYPE /AWS1/SSMPOLICY OPTIONAL
    !IV_POLICYID TYPE /AWS1/SSMPOLICYID OPTIONAL
    !IV_POLICYHASH TYPE /AWS1/SSMPOLICYHASH OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmputresourceplyrsp
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMMALFORMEDRESRCPL00
    /AWS1/CX_SSMRESOURCENOTFOUNDEX
    /AWS1/CX_SSMRESRCPLYCONFLICTEX
    /AWS1/CX_SSMRESRCPLYINVPARAMEX
    /AWS1/CX_SSMRESRCPLYLMTEXCDEX
    /AWS1/CX_SSMRESRCPLYNOTFOUNDEX
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_resourcearn` `TYPE /AWS1/SSMRESOURCEARNSTRING` `/AWS1/SSMRESOURCEARNSTRING`¶

Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

`iv_policy` `TYPE /AWS1/SSMPOLICY` `/AWS1/SSMPOLICY`¶

A policy you want to associate with a resource.

Optional arguments:¶

`iv_policyid` `TYPE /AWS1/SSMPOLICYID` `/AWS1/SSMPOLICYID`¶

The policy ID.

`iv_policyhash` `TYPE /AWS1/SSMPOLICYHASH` `/AWS1/SSMPOLICYHASH`¶

ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmputresourceplyrsp` `/AWS1/CL_SSMPUTRESOURCEPLYRSP`¶

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->putresourcepolicy(
  iv_policy = |string|
  iv_policyhash = |string|
  iv_policyid = |string|
  iv_resourcearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_policyid = lo_result->get_policyid( ).
  lv_policyhash = lo_result->get_policyhash( ).
ENDIF.

/AWS1/IF_SSM=>PUTRESOURCEPOLICY()¶