Updated on 2024-06-21 GMT+08:00

Resource Formation Service (RFS)

The Organizations service provides Service Control Policies (SCPs) to set access control policies.

SCPs do not actually grant any permissions to a principal. They only set the permissions boundary for the principal. When SCPs are attached to a member account or an organizational unit (OU), they do not directly grant permissions to that member account or OU. Instead, the SCPs just determine what permissions are available for that member account or the member accounts under that OU.

This section describes the elements used by Organizations SCPs. The elements include actions, resources, and conditions.

For details about how to use these elements to create a custom SCP, see Creating an SCP.

Actions

Actions are specific operations that are allowed or denied in an SCP.

  • The Access Level column describes how the action is classified (List, Read, or Write). This classification helps you understand the level of access that an action grants when you use it in an SCP.
  • The Resource Type column indicates whether the action supports resource-level permissions.
    • You can use a wildcard (*) to indicate all resource types. If this column is empty (-), the action does not support resource-level permissions, and you must specify all resources ("*") in your SCP statements.
    • If this column includes a resource type, you must specify the URN in the Resource element of your statements.
    • Required resources are marked with asterisks (*) in the table. If you specify a resource in a statement using this action, then it must be of this type.

    For details about the resource types defined by Resource Formation Service (RFS), see Resources.

  • The Condition Key column contains keys that you can specify in the Condition element of an SCP statement.
    • If the Resource Type column has values for an action, the condition key takes effect only for the listed resource types.
    • If the Resource Type column is empty (-) for an action, the condition key takes effect for all resources that action supports.
    • If the Condition Key column is empty (-) for an action, the action does not support any condition keys.

    For details about the condition keys defined by Resource Formation Service (RFS), see Conditions.

The following table lists the actions that you can define in SCP statements for Resource Formation Service (RFS).

Table 1 Actions supported by Resource Formation Service (RFS)

Action

Description

Access Level

Resource Type (*: required)

Condition Key

rf:privateTemplate:list

Grants permission to obtain private template list of project.

list

privateTemplate *

-

rf:privateTemplate:create

Grants permission to create a private template.

write

privateTemplate *

-

rf:privateTemplate:delete

Grants permission to delete a private template.

write

privateTemplate *

-

rf:privateTemplate:showMetadata

Grants permission to display the details of private template.

read

privateTemplate *

-

rf:privateTemplate:updateMetadata

Grants permission to update the metadata of private template.

write

privateTemplate *

-

rf:privateTemplate:listVersions

Grants permission to display all version details of private template.

list

privateTemplate *

-

rf:privateTemplate:createVersion

Grants permission to create a private template version.

write

privateTemplate *

-

rf:privateTemplate:showVersionContent

Grants permission to obtain the content of private template version.

read

privateTemplate *

-

rf:privateTemplate:deleteVersion

Grants permission to delete a private template version.

write

privateTemplate *

-

rf:privateTemplate:showVersionMetadata

Grants permission to get the metadata of private template version.

read

privateTemplate *

-

rf:stack:create

Grants permission to create a stack.

write

stack *

-

rf:stack:deploy

Grants permission to deploy a stack.

write

stack *

-

rf:stack:list

Grants permission to list all stacks.

list

stack *

-

rf:stack:getMetadata

Grants permission to get the metadata of a stack.

read

stack *

-

rf:stack:delete

Grants permission to delete a stack.

write

stack *

-

rf:stack:getTemplate

Grants permission to get the template of a stack.

read

stack *

-

rf:stack:listEvents

Grants permission to list deployment events of a stack.

list

stack *

-

rf:stack:listResources

Grants permission to list all resources of a stack.

list

stack *

-

rf:stack:listOutputs

Grants permission to list all outputs of a stack.

list

stack *

-

rf:stack:createExecutionPlan

Grants permission to create an execution plan.

write

stack *

-

rf:stack:getExecutionPlanMetadata

Grants permission to get the metadata of an execution plan.

read

stack *

-

rf:stack:getExecutionPlan

Grants permission to get an execution plan.

read

stack *

-

rf:stack:applyExecutionPlan

Grants permission to apply an execution plan.

write

stack *

-

rf:stack:listExecutionPlans

Grants permission to list all execution plans.

list

stack *

-

rf:stack:deleteExecutionPlan

Grants permission to delete an execution plan.

write

stack *

-

rf:stack:continueRollback

Grants permission to continue rolling back the stack.

write

stack *

-

rf:stack:continueDeploy

Grants permission to continue to deploy the stack.

write

stack *

-

rf:stack:estimateExecutionPlanPrice

Grants permission to estimate the price of an execution plan.

read

stack *

-

rf:stack:update

Grants permission to update stack properties.

write

stack *

-

rf:stackSet:create

Grants permission to create a stack set.

write

stackSet *

-

rf:stackSet:list

Grants permission to list all stack sets.

list

stackSet *

-

rf:stackSet:showTemplate

Grants permission to show the template of a stack set.

read

stackSet *

-

rf:stackSet:showMetadata

Grants permission to show the metadata of a stack set.

read

stackSet *

-

rf:stackSet:deploy

Grants permission to deploy a stack set.

write

stackSet *

-

rf:stackSet:delete

Grants permission to delete a stack set.

write

stackSet *

-

rf:stackSet:update

Grants permission to update stack set properties.

write

stackSet *

-

rf:stackSet:listStackInstances

Grants permission to list all stack instances.

list

stackSet *

-

rf:stackSet:createStackInstances

Grants permission to create stack instances.

write

stackSet *

-

rf:stackSet:deleteStackInstances

Grants permission to delete stack instances.

write

stackSet *

-

rf:stackSet:showOperationMetadata

Grants permission to show the metadata of an stack set operation.

read

stackSet *

-

rf:stackSet:listOperations

Grants permission to list all stack set operations.

list

stackSet *

-

Each API of Resource Formation Service (RFS) usually supports one or more actions. Table 2 lists the supported actions and dependencies.

Table 2 Actions and dependencies supported by Resource Formation Service (RFS) APIs

API

Action

Dependencies

GET /v1/{project_id}/templates

rf:privateTemplate:list

-

POST /v1/{project_id}/templates

rf:privateTemplate:create

-

DELETE /v1/{project_id}/templates/{template_name}

rf:privateTemplate:delete

-

GET /v1/{project_id}/templates/{template_name}/metadata

rf:privateTemplate:showMetadata

-

PATCH /v1/{project_id}/templates/{template_name}/metadata

rf:privateTemplate:updateMetadata

-

GET /v1/{project_id}/templates/{template_name}/versions

rf:privateTemplate:listVersions

-

POST /v1/{project_id}/templates/{template_name}/versions

rf:privateTemplate:createVersion

-

GET /v1/{project_id}/templates/{template_name}/versions/{version_id}

rf:privateTemplate:showVersionContent

-

DELETE /v1/{project_id}/templates/{template_name}/versions/{version_id}

rf:privateTemplate:deleteVersion

-

GET /v1/{project_id}/templates/{template_name}/versions/{version_id}/metadata

rf:privateTemplate:showVersionMetadata

-

POST /v1/{project_id}/stacks

rf:stack:create

  • kms:cmk:decryptDataKey
  • iam:agencies:pass

POST /v1/{project_id}/stacks/{stack_name}/deployments

rf:stack:deploy

kms:cmk:decryptDataKey

GET /v1/{project_id}/stacks

rf:stack:list

-

GET /v1/{project_id}/stacks/{stack_name}/metadata

rf:stack:getMetadata

-

DELETE /v1/{project_id}/stacks/{stack_name}

rf:stack:delete

-

GET /v1/{project_id}/stacks/{stack_name}/templates

rf:stack:getTemplate

-

GET /v1/{project_id}/stacks/{stack_name}/events

rf:stack:listEvents

-

GET /v1/{project_id}/stacks/{stack_name}/resources

rf:stack:listResources

-

GET /v1/{project_id}/stacks/{stack_name}/outputs

rf:stack:listOutputs

-

POST /v1/{project_id}/stacks/{stack_name}/execution-plans

rf:stack:createExecutionPlan

kms:cmk:decryptDataKey

GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}/metadata

rf:stack:getExecutionPlanMetadata

-

GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}

rf:stack:getExecutionPlan

-

POST /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}

rf:stack:applyExecutionPlan

-

GET /v1/{project_id}/stacks/{stack_name}/execution-plans

rf:stack:listExecutionPlans

-

DELETE /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}

rf:stack:deleteExecutionPlan

-

POST /v1/{project_id}/stacks/{stack_name}/rollbacks

rf:stack:continueRollback

-

POST /v1/{project_id}/stacks/{stack_name}/continuations

rf:stack:continueDeploy

-

GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}/prices

rf:stack:estimateExecutionPlanPrice

bss:discount:view

PATCH /v1/{project_id}/stacks/{stack_name}

rf:stack:update

iam:agencies:pass

POST /v1/stack-sets

rf:stackSet:create

iam:agencies:pass

GET /v1/stack-sets

rf:stackSet:list

-

GET /v1/stack-sets/{stack_set_name}/templates

rf:stackSet:showTemplate

-

GET /v1/stack-sets/{stack_set_name}/metadata

rf:stackSet:showMetadata

-

POST /v1/stack-sets/{stack_set_name}/deployments

rf:stackSet:deploy

-

DELETE /v1/stack-sets/{stack_set_name}

rf:stackSet:delete

-

PATCH /v1/stack-sets/{stack_set_name}

rf:stackSet:update

iam:agencies:pass

GET /v1/stack-sets/{stack_set_name}/stack-instances

rf:stackSet:listStackInstances

-

GET /v1/stack-sets/{stack_set_name}/operations/{stack_set_operation_id}/metadata

rf:stackSet:showOperationMetadata

-

GET /v1/stack-sets/{stack_set_name}/operations

rf:stackSet:listOperations

-

Resources

A resource type indicates the resources that an SCP applies to. If you specify a resource type for any action in Table 3, the resource URN must be specified in the SCP statements using that action, and the SCP applies only to resources of this type. If no resource type is specified, the Resource element is marked with an asterisk (*) and the SCP applies to all resources. You can also set condition keys in an SCP to define resource types.

The following table lists the resource types that you can define in SCP statements for Resource Formation Service (RFS).

Table 3 Resource types supported by Resource Formation Service (RFS)

Resource Type

URN

privateTemplate

rf:<region>:<account-id>:privateTemplate:<template-name>

stackSet

rf:<region>:<account-id>:stackSet:<stack-set-name>/<stack-set-id>

stack

rf:<region>:<account-id>:stack:<stack-name>

Conditions

Resource Formation Service (RFS) does not support service-specific condition keys in SCPs.

It can only use global condition keys applicable to all services. For details, see Global Condition Keys.