Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. PostgreSQL
  5. Schema

Schema

Create a Schema Resource

new Schema(name: string, args?: SchemaArgs, opts?: CustomResourceOptions);
def Schema(resource_name: str, opts: Optional[ResourceOptions] = None, database: Optional[str] = None, drop_cascade: Optional[bool] = None, if_not_exists: Optional[bool] = None, name: Optional[str] = None, owner: Optional[str] = None, policies: Optional[Sequence[SchemaPolicyArgs]] = None)
func NewSchema(ctx *Context, name string, args *SchemaArgs, opts ...ResourceOption) (*Schema, error)
public Schema(string name, SchemaArgs? args = null, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Schema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Schema resource accepts the following input properties:

Database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

DropCascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

IfNotExists bool

When true, use the existing schema if it exists. (Default: true)

Name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

Owner string

The ROLE who owns the schema.

Policies List<Pulumi.PostgreSql.Inputs.SchemaPolicyArgs>

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

Database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

DropCascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

IfNotExists bool

When true, use the existing schema if it exists. (Default: true)

Name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

Owner string

The ROLE who owns the schema.

Policies []SchemaPolicy

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

dropCascade boolean

When true, will also drop all the objects that are contained in the schema. (Default: false)

ifNotExists boolean

When true, use the existing schema if it exists. (Default: true)

name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

owner string

The ROLE who owns the schema.

policies SchemaPolicy[]

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

database str

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

drop_cascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

if_not_exists bool

When true, use the existing schema if it exists. (Default: true)

name str

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

owner str

The ROLE who owns the schema.

policies Sequence[SchemaPolicyArgs]

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="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.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an 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, database: Optional[str] = None, drop_cascade: Optional[bool] = None, if_not_exists: Optional[bool] = None, name: Optional[str] = None, owner: Optional[str] = None, policies: Optional[Sequence[SchemaPolicyArgs]] = 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)
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.

The following state arguments are supported:

Database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

DropCascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

IfNotExists bool

When true, use the existing schema if it exists. (Default: true)

Name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

Owner string

The ROLE who owns the schema.

Policies List<Pulumi.PostgreSql.Inputs.SchemaPolicyArgs>

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

Database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

DropCascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

IfNotExists bool

When true, use the existing schema if it exists. (Default: true)

Name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

Owner string

The ROLE who owns the schema.

Policies []SchemaPolicy

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

database string

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

dropCascade boolean

When true, will also drop all the objects that are contained in the schema. (Default: false)

ifNotExists boolean

When true, use the existing schema if it exists. (Default: true)

name string

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

owner string

The ROLE who owns the schema.

policies SchemaPolicy[]

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

database str

The DATABASE in which where this schema will be created. (Default: The database used by your provider configuration)

drop_cascade bool

When true, will also drop all the objects that are contained in the schema. (Default: false)

if_not_exists bool

When true, use the existing schema if it exists. (Default: true)

name str

The name of the schema. Must be unique in the PostgreSQL database instance where it is configured.

owner str

The ROLE who owns the schema.

policies Sequence[SchemaPolicyArgs]

Can be specified multiple times for each policy. Each policy block supports fields documented below.

Deprecated: Use postgresql_grant resource instead (with object_type="schema")

Supporting Types

SchemaPolicy

Create bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA.

CreateWithGrant bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA and the ability to GRANT the CREATE privilege to other ROLEs.

Role string

The ROLE who is receiving the policy. If this value is empty or not specified it implies the policy is referring to the PUBLIC role.

Usage bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA.

UsageWithGrant bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA and the ability to GRANT the USAGE privilege to other ROLEs.

Create bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA.

CreateWithGrant bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA and the ability to GRANT the CREATE privilege to other ROLEs.

Role string

The ROLE who is receiving the policy. If this value is empty or not specified it implies the policy is referring to the PUBLIC role.

Usage bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA.

UsageWithGrant bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA and the ability to GRANT the USAGE privilege to other ROLEs.

create boolean

Should the specified ROLE have CREATE privileges to the specified SCHEMA.

createWithGrant boolean

Should the specified ROLE have CREATE privileges to the specified SCHEMA and the ability to GRANT the CREATE privilege to other ROLEs.

role string

The ROLE who is receiving the policy. If this value is empty or not specified it implies the policy is referring to the PUBLIC role.

usage boolean

Should the specified ROLE have USAGE privileges to the specified SCHEMA.

usageWithGrant boolean

Should the specified ROLE have USAGE privileges to the specified SCHEMA and the ability to GRANT the USAGE privilege to other ROLEs.

create bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA.

create_with_grant bool

Should the specified ROLE have CREATE privileges to the specified SCHEMA and the ability to GRANT the CREATE privilege to other ROLEs.

role str

The ROLE who is receiving the policy. If this value is empty or not specified it implies the policy is referring to the PUBLIC role.

usage bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA.

usage_with_grant bool

Should the specified ROLE have USAGE privileges to the specified SCHEMA and the ability to GRANT the USAGE privilege to other ROLEs.

Package Details

Repository
https://github.com/pulumi/pulumi-postgresql
License
Apache-2.0
Notes
This Pulumi package is based on the postgresql Terraform Provider.