Schema class

This is a Terraform resource for managing an AWS Verified Permissions Policy Store Schema.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.verifiedpermissions.Schema("example", {
    definition: {
        value: JSON.stringify({
            Namespace: {
                entityTypes: {},
                actions: {},
            },
        }),
    },
    policyStoreId: exampleAwsVerifiedpermissionsPolicyStore.policyStoreId,
});
import pulumi
import json
import pulumi_aws as aws

example = aws.verifiedpermissions.Schema("example",
    definition={
        "value": json.dumps({
            "Namespace": {
                "entityTypes": {},
                "actions": {},
            },
        }),
    },
    policy_store_id=example_aws_verifiedpermissions_policy_store["policyStoreId"])
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedPermissions.Schema("example", new()
    {
        Definition = new Aws.VerifiedPermissions.Inputs.SchemaDefinitionArgs
        {
            Value = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Namespace"] = new Dictionary<string, object?>
                {
                    ["entityTypes"] = new Dictionary<string, object?>
                    {
                    },
                    ["actions"] = new Dictionary<string, object?>
                    {
                    },
                },
            }),
        },
        PolicyStoreId = exampleAwsVerifiedpermissionsPolicyStore.PolicyStoreId,
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/verifiedpermissions"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]map[string]map[string]interface{}{
			"Namespace": map[string]map[string]interface{}{
				"entityTypes": map[string]interface{}{},
				"actions":     map[string]interface{}{},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = verifiedpermissions.NewSchema(ctx, "example", &verifiedpermissions.SchemaArgs{
			Definition: &verifiedpermissions.SchemaDefinitionArgs{
				Value: pulumi.String(json0),
			},
			PolicyStoreId: pulumi.Any(exampleAwsVerifiedpermissionsPolicyStore.PolicyStoreId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedpermissions_schema" "example" {
  definition = {
    value = jsonencode({
      "Namespace" = {
        "entityTypes" = {}
        "actions"     = {}
      }
    })
  }
  policy_store_id = exampleAwsVerifiedpermissionsPolicyStore.policyStoreId
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.verifiedpermissions.Schema;
import com.pulumi.aws.verifiedpermissions.SchemaArgs;
import com.pulumi.aws.verifiedpermissions.inputs.SchemaDefinitionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 Schema("example", SchemaArgs.builder()
            .definition(SchemaDefinitionArgs.builder()
                .value(serializeJson(
                    jsonObject(
                        jsonProperty("Namespace", jsonObject(
                            jsonProperty("entityTypes", jsonObject(

                            )),
                            jsonProperty("actions", jsonObject(

                            ))
                        ))
                    )))
                .build())
            .policyStoreId(exampleAwsVerifiedpermissionsPolicyStore.policyStoreId())
            .build());

    }
}
resources:
  example:
    type: aws:verifiedpermissions:Schema
    properties:
      definition:
        value:
          fn::toJSON:
            Namespace:
              entityTypes: {}
              actions: {}
      policyStoreId: ${exampleAwsVerifiedpermissionsPolicyStore.policyStoreId}

Import

Using pulumi import, import Verified Permissions Policy Store Schema using the policyStoreId. For example:

$ pulumi import aws:verifiedpermissions/schema:Schema example DxQg2j8xvXJQ1tQCYNWj9T

Constructors

Schema(String name, {SchemaArgs? args, CustomResourceOptions? options})
Creates a new Schema. name The Pulumi resource name. args Arguments used to configure this Schema. The set of arguments for Schema. options Resource options controlling this resource's behavior.
Schema.reference(String urn)
Creates a typed reference to an existing Schema resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
definition ↔ Output<SchemaDefinition>
The definition of the schema.
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
namespaces ↔ Output<List<String>>
(Optional) Identifies the namespaces of the entities referenced by this schema.
latefinal
policyStoreId ↔ Output<String>
The ID of the Policy Store.
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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, {SchemaState? state, CustomResourceOptions? options}) → Schema
Gets an existing Schema resource's state with the given name and id.