AWS v6.60.0, Nov 19 24

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.verifiedpermissions.Schema

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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 static com.pulumi.codegen.internal.Serialization.*;
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 Schema("example", SchemaArgs.builder()
            .policyStoreId(exampleAwsVerifiedpermissionsPolicyStore.policyStoreId())
            .definition(SchemaDefinitionArgs.builder()
                .value(serializeJson(
                    jsonObject(
                        jsonProperty("Namespace", jsonObject(
                            jsonProperty("entityTypes", jsonObject(

                            )),
                            jsonProperty("actions", jsonObject(

                            ))
                        ))
                    )))
                .build())
            .build());

    }
}

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

Create Schema Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);

@overload
def Schema(resource_name: str,
           args: SchemaArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           policy_store_id: Optional[str] = None,
           definition: Optional[SchemaDefinitionArgs] = None)

func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)

public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)

public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

type: aws:verifiedpermissions:Schema
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 SchemaArgs: 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 SchemaArgs: 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 SchemaArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SchemaArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SchemaArgs: 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 exampleschemaResourceResourceFromVerifiedpermissionsschema = new Aws.VerifiedPermissions.Schema("exampleschemaResourceResourceFromVerifiedpermissionsschema", new()
{
    PolicyStoreId = "string",
    Definition = new Aws.VerifiedPermissions.Inputs.SchemaDefinitionArgs
    {
        Value = "string",
    },
});

example, err := verifiedpermissions.NewSchema(ctx, "exampleschemaResourceResourceFromVerifiedpermissionsschema", &verifiedpermissions.SchemaArgs{
	PolicyStoreId: pulumi.String("string"),
	Definition: &verifiedpermissions.SchemaDefinitionArgs{
		Value: pulumi.String("string"),
	},
})

var exampleschemaResourceResourceFromVerifiedpermissionsschema = new Schema("exampleschemaResourceResourceFromVerifiedpermissionsschema", SchemaArgs.builder()
    .policyStoreId("string")
    .definition(SchemaDefinitionArgs.builder()
        .value("string")
        .build())
    .build());

exampleschema_resource_resource_from_verifiedpermissionsschema = aws.verifiedpermissions.Schema("exampleschemaResourceResourceFromVerifiedpermissionsschema",
    policy_store_id="string",
    definition={
        "value": "string",
    })

const exampleschemaResourceResourceFromVerifiedpermissionsschema = new aws.verifiedpermissions.Schema("exampleschemaResourceResourceFromVerifiedpermissionsschema", {
    policyStoreId: "string",
    definition: {
        value: "string",
    },
});

type: aws:verifiedpermissions:Schema
properties:
    definition:
        value: string
    policyStoreId: string

Schema 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 Schema resource accepts the following input properties:

PolicyStoreId string: The ID of the Policy Store.
Definition SchemaDefinition: The definition of the schema.

PolicyStoreId string: The ID of the Policy Store.
Definition SchemaDefinitionArgs: The definition of the schema.

policyStoreId String: The ID of the Policy Store.
definition SchemaDefinition: The definition of the schema.

policyStoreId string: The ID of the Policy Store.
definition SchemaDefinition: The definition of the schema.

policy_store_id str: The ID of the Policy Store.
definition SchemaDefinitionArgs: The definition of the schema.

policyStoreId String: The ID of the Policy Store.
definition Property Map: The definition of the schema.

Outputs

All input properties are implicitly available as output properties. Additionally, the Schema resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Namespaces List<string>: (Optional) Identifies the namespaces of the entities referenced by this schema.

Id string: The provider-assigned unique ID for this managed resource.
Namespaces []string: (Optional) Identifies the namespaces of the entities referenced by this schema.

id String: The provider-assigned unique ID for this managed resource.
namespaces List<String>: (Optional) Identifies the namespaces of the entities referenced by this schema.

id string: The provider-assigned unique ID for this managed resource.
namespaces string[]: (Optional) Identifies the namespaces of the entities referenced by this schema.

id str: The provider-assigned unique ID for this managed resource.
namespaces Sequence[str]: (Optional) Identifies the namespaces of the entities referenced by this schema.

id String: The provider-assigned unique ID for this managed resource.
namespaces List<String>: (Optional) Identifies the namespaces of the entities referenced by this schema.

Look up Existing Schema Resource

Get an existing Schema 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?: SchemaState, opts?: CustomResourceOptions): Schema

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        definition: Optional[SchemaDefinitionArgs] = None,
        namespaces: Optional[Sequence[str]] = None,
        policy_store_id: Optional[str] = None) -> Schema

func GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)

public static Schema Get(string name, Input<string> id, SchemaState? state, CustomResourceOptions? opts = null)

public static Schema get(String name, Output<String> id, SchemaState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

The following state arguments are supported:

Definition SchemaDefinition: The definition of the schema.
Namespaces List<string>: (Optional) Identifies the namespaces of the entities referenced by this schema.
PolicyStoreId string: The ID of the Policy Store.

Definition SchemaDefinitionArgs: The definition of the schema.
Namespaces []string: (Optional) Identifies the namespaces of the entities referenced by this schema.
PolicyStoreId string: The ID of the Policy Store.

definition SchemaDefinition: The definition of the schema.
namespaces List<String>: (Optional) Identifies the namespaces of the entities referenced by this schema.
policyStoreId String: The ID of the Policy Store.

definition SchemaDefinition: The definition of the schema.
namespaces string[]: (Optional) Identifies the namespaces of the entities referenced by this schema.
policyStoreId string: The ID of the Policy Store.

definition SchemaDefinitionArgs: The definition of the schema.
namespaces Sequence[str]: (Optional) Identifies the namespaces of the entities referenced by this schema.
policy_store_id str: The ID of the Policy Store.

definition Property Map: The definition of the schema.
namespaces List<String>: (Optional) Identifies the namespaces of the entities referenced by this schema.
policyStoreId String: The ID of the Policy Store.

Supporting Types

SchemaDefinition, SchemaDefinitionArgs

Value string: A JSON string representation of the schema.

Value string: A JSON string representation of the schema.

value String: A JSON string representation of the schema.

value string: A JSON string representation of the schema.

value str: A JSON string representation of the schema.

value String: A JSON string representation of the schema.

Import

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

console

% pulumi import aws_verifiedpermissions_schema.example DxQg2j8xvXJQ1tQCYNWj9T

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 aws Terraform Provider.

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.verifiedpermissions.Schema

On this page

On this page

Example Usage

Basic Usage

Create Schema Resource

Constructor syntax

Parameters

Constructor example

Schema Resource Properties

Inputs

Outputs

Look up Existing Schema Resource

Supporting Types

SchemaDefinition, SchemaDefinitionArgs

Import

Package Details

On this page

On this page