published on Wednesday, Mar 11, 2026 by Pulumi
published on Wednesday, Mar 11, 2026 by Pulumi
Manages an AWS RAM (Resource Access Manager) Permission.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ram.Permission("example", {
name: "custom-backup",
policyTemplate: `{
\\"Effect\\": \\"Allow\\",
\\"Action\\": [
\\t\\"backup:ListProtectedResourcesByBackupVault\\",
\\t\\"backup:ListRecoveryPointsByBackupVault\\",
\\t\\"backup:DescribeRecoveryPoint\\",
\\t\\"backup:DescribeBackupVault\\"
]
}
`,
resourceType: "backup:BackupVault",
tags: {
Name: "custom-backup",
},
});
import pulumi
import pulumi_aws as aws
example = aws.ram.Permission("example",
name="custom-backup",
policy_template="""{
\"Effect\": \"Allow\",
\"Action\": [
\t\"backup:ListProtectedResourcesByBackupVault\",
\t\"backup:ListRecoveryPointsByBackupVault\",
\t\"backup:DescribeRecoveryPoint\",
\t\"backup:DescribeBackupVault\"
]
}
""",
resource_type="backup:BackupVault",
tags={
"Name": "custom-backup",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ram"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ram.NewPermission(ctx, "example", &ram.PermissionArgs{
Name: pulumi.String("custom-backup"),
PolicyTemplate: pulumi.String(`{
\"Effect\": \"Allow\",
\"Action\": [
\t\"backup:ListProtectedResourcesByBackupVault\",
\t\"backup:ListRecoveryPointsByBackupVault\",
\t\"backup:DescribeRecoveryPoint\",
\t\"backup:DescribeBackupVault\"
]
}
`),
ResourceType: pulumi.String("backup:BackupVault"),
Tags: pulumi.StringMap{
"Name": pulumi.String("custom-backup"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ram.Permission("example", new()
{
Name = "custom-backup",
PolicyTemplate = @"{
\""Effect\"": \""Allow\"",
\""Action\"": [
\t\""backup:ListProtectedResourcesByBackupVault\"",
\t\""backup:ListRecoveryPointsByBackupVault\"",
\t\""backup:DescribeRecoveryPoint\"",
\t\""backup:DescribeBackupVault\""
]
}
",
ResourceType = "backup:BackupVault",
Tags =
{
{ "Name", "custom-backup" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ram.Permission;
import com.pulumi.aws.ram.PermissionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Permission("example", PermissionArgs.builder()
.name("custom-backup")
.policyTemplate("""
{
\"Effect\": \"Allow\",
\"Action\": [
\t\"backup:ListProtectedResourcesByBackupVault\",
\t\"backup:ListRecoveryPointsByBackupVault\",
\t\"backup:DescribeRecoveryPoint\",
\t\"backup:DescribeBackupVault\"
]
}
""")
.resourceType("backup:BackupVault")
.tags(Map.of("Name", "custom-backup"))
.build());
}
}
resources:
example:
type: aws:ram:Permission
properties:
name: custom-backup
policyTemplate: |
{
\"Effect\": \"Allow\",
\"Action\": [
\t\"backup:ListProtectedResourcesByBackupVault\",
\t\"backup:ListRecoveryPointsByBackupVault\",
\t\"backup:DescribeRecoveryPoint\",
\t\"backup:DescribeBackupVault\"
]
}
resourceType: backup:BackupVault
tags:
Name: custom-backup
Create Permission Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Permission(name: string, args: PermissionArgs, opts?: CustomResourceOptions);@overload
def Permission(resource_name: str,
args: PermissionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Permission(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy_template: Optional[str] = None,
resource_type: Optional[str] = None,
name: Optional[str] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[PermissionTimeoutsArgs] = None)func NewPermission(ctx *Context, name string, args PermissionArgs, opts ...ResourceOption) (*Permission, error)public Permission(string name, PermissionArgs args, CustomResourceOptions? opts = null)
public Permission(String name, PermissionArgs args)
public Permission(String name, PermissionArgs args, CustomResourceOptions options)
type: aws:ram:Permission
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PermissionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PermissionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PermissionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PermissionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PermissionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplepermissionResourceResourceFromRampermission = new Aws.Ram.Permission("examplepermissionResourceResourceFromRampermission", new()
{
PolicyTemplate = "string",
ResourceType = "string",
Name = "string",
Region = "string",
Tags =
{
{ "string", "string" },
},
Timeouts = new Aws.Ram.Inputs.PermissionTimeoutsArgs
{
Delete = "string",
},
});
example, err := ram.NewPermission(ctx, "examplepermissionResourceResourceFromRampermission", &ram.PermissionArgs{
PolicyTemplate: pulumi.String("string"),
ResourceType: pulumi.String("string"),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &ram.PermissionTimeoutsArgs{
Delete: pulumi.String("string"),
},
})
var examplepermissionResourceResourceFromRampermission = new com.pulumi.aws.ram.Permission("examplepermissionResourceResourceFromRampermission", com.pulumi.aws.ram.PermissionArgs.builder()
.policyTemplate("string")
.resourceType("string")
.name("string")
.region("string")
.tags(Map.of("string", "string"))
.timeouts(PermissionTimeoutsArgs.builder()
.delete("string")
.build())
.build());
examplepermission_resource_resource_from_rampermission = aws.ram.Permission("examplepermissionResourceResourceFromRampermission",
policy_template="string",
resource_type="string",
name="string",
region="string",
tags={
"string": "string",
},
timeouts={
"delete": "string",
})
const examplepermissionResourceResourceFromRampermission = new aws.ram.Permission("examplepermissionResourceResourceFromRampermission", {
policyTemplate: "string",
resourceType: "string",
name: "string",
region: "string",
tags: {
string: "string",
},
timeouts: {
"delete": "string",
},
});
type: aws:ram:Permission
properties:
name: string
policyTemplate: string
region: string
resourceType: string
tags:
string: string
timeouts:
delete: string
Permission Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Permission resource accepts the following input properties:
- Policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- Resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - Name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Permission
Timeouts
- Policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- Resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - Name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Permission
Timeouts Args
- policy
Template String - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- resource
Type String - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - name String
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Permission
Timeouts
- policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Permission
Timeouts
- policy_
template str - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- resource_
type str - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - name str
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Permission
Timeouts Args
- policy
Template String - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- resource
Type String - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - name String
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Permission resource produces the following output properties:
- Arn string
- ARN of the permission.
- Default
Version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The current status of the permission.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Version string
- The version of the permission associated with this resource share.
- Arn string
- ARN of the permission.
- Default
Version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The current status of the permission.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Version string
- The version of the permission associated with this resource share.
- arn String
- ARN of the permission.
- default
Version Boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The current status of the permission.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - version String
- The version of the permission associated with this resource share.
- arn string
- ARN of the permission.
- default
Version boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The current status of the permission.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - version string
- The version of the permission associated with this resource share.
- arn str
- ARN of the permission.
- default_
version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The current status of the permission.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - version str
- The version of the permission associated with this resource share.
- arn String
- ARN of the permission.
- default
Version Boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The current status of the permission.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - version String
- The version of the permission associated with this resource share.
Look up Existing Permission Resource
Get an existing Permission resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PermissionState, opts?: CustomResourceOptions): Permission@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
default_version: Optional[bool] = None,
name: Optional[str] = None,
policy_template: Optional[str] = None,
region: Optional[str] = None,
resource_type: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
timeouts: Optional[PermissionTimeoutsArgs] = None,
version: Optional[str] = None) -> Permissionfunc GetPermission(ctx *Context, name string, id IDInput, state *PermissionState, opts ...ResourceOption) (*Permission, error)public static Permission Get(string name, Input<string> id, PermissionState? state, CustomResourceOptions? opts = null)public static Permission get(String name, Output<String> id, PermissionState state, CustomResourceOptions options)resources: _: type: aws:ram:Permission get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the permission.
- Default
Version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- Name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- Policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - Status string
- The current status of the permission.
- Dictionary<string, string>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Permission
Timeouts - Version string
- The version of the permission associated with this resource share.
- Arn string
- ARN of the permission.
- Default
Version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- Name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- Policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - Status string
- The current status of the permission.
- map[string]string
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timeouts
Permission
Timeouts Args - Version string
- The version of the permission associated with this resource share.
- arn String
- ARN of the permission.
- default
Version Boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- name String
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- policy
Template String - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- resource
Type String - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - status String
- The current status of the permission.
- Map<String,String>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Permission
Timeouts - version String
- The version of the permission associated with this resource share.
- arn string
- ARN of the permission.
- default
Version boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- name string
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- policy
Template string - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- resource
Type string - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - status string
- The current status of the permission.
- {[key: string]: string}
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Permission
Timeouts - version string
- The version of the permission associated with this resource share.
- arn str
- ARN of the permission.
- default_
version bool - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- name str
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- policy_
template str - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- resource_
type str - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - status str
- The current status of the permission.
- Mapping[str, str]
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts
Permission
Timeouts Args - version str
- The version of the permission associated with this resource share.
- arn String
- ARN of the permission.
- default
Version Boolean - Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
- name String
- Specifies the name of the customer managed permission. The name must be unique within the AWS Region.
- policy
Template String - A string in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- resource
Type String - Specifies the name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive. - status String
- The current status of the permission.
- Map<String>
- A map of tags to assign to the resource share. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timeouts Property Map
- version String
- The version of the permission associated with this resource share.
Supporting Types
PermissionTimeouts, PermissionTimeoutsArgs
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Import
Identity Schema
Required
arn(String) Permission ARN.
Using pulumi import, import RAM (Resource Access Manager) Permission using the example_id_arg. For example:
$ pulumi import aws:ram/permission:Permission example arn:aws:ram:us-west-1:123456789012:permission/test-permission
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
published on Wednesday, Mar 11, 2026 by Pulumi
