Permission class
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",
})
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 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ram_permission" "example" {
name = "custom-backup"
policy_template = "{\n \\\"Effect\\\": \\\"Allow\\\",\n \\\"Action\\\": [\n\\t\\\"backup:ListProtectedResourcesByBackupVault\\\",\n\\t\\\"backup:ListRecoveryPointsByBackupVault\\\",\n\\t\\\"backup:DescribeRecoveryPoint\\\",\n\\t\\\"backup:DescribeBackupVault\\\"\n ]\n}\n"
resource_type = "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.ArrayList;
import java.util.Arrays;
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
Import
Identity Schema
Required
arn(String) Permission ARN.
Using pulumi import, import RAM (Resource Access Manager) Permission using the exampleIdArg. For example:
$ pulumi import aws:ram/permission:Permission example arn:aws:ram:us-west-1:123456789012:permission/test-permission
Constructors
- Permission(String name, {PermissionArgs? args, CustomResourceOptions? options})
-
Creates a new Permission.
nameThe Pulumi resource name.argsArguments used to configure this Permission. The set of arguments for Permission.optionsResource options controlling this resource's behavior. - Permission.reference(String urn)
- Creates a typed reference to an existing Permission resource.
Properties
-
arn
↔ Output<
String> -
ARN of the permission.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
defaultVersion
↔ Output<
bool> -
Whether this is the default version of the managed permission.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the customer managed permission. The name must be unique within the AWS Region.
latefinal
-
policyTemplate
↔ Output<
String> -
String in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
resourceType
↔ Output<
String> -
Name of the resource type that this customer managed permission applies to. The format is
<service-code>:<resource-type>and is not case sensitive.latefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
Current status of the permission.
latefinal
-
Map of tags to assign to the resource share. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
PermissionTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
Version of the permission associated with this resource share.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PermissionState? state, CustomResourceOptions? options}) → Permission -
Gets an existing Permission resource's state with the given
nameandid.