SecurityLabel class

The postgresql.SecurityLabel resource creates and manages security labels.

See PostgreSQL documentation

> Note: This resource needs Postgresql version 11 or above.

Usage

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

const myRole = new postgresql.Role("my_role", {
    name: "my_role",
    login: true,
});
const workload = new postgresql.SecurityLabel("workload", {
    objectType: "role",
    objectName: myRole.name,
    labelProvider: "pgaadauth",
    label: "aadauth,oid=00000000-0000-0000-0000-000000000000,type=service",
});
import pulumi
import pulumi_postgresql as postgresql

my_role = postgresql.Role("my_role",
    name="my_role",
    login=True)
workload = postgresql.SecurityLabel("workload",
    object_type="role",
    object_name=my_role.name,
    label_provider="pgaadauth",
    label="aadauth,oid=00000000-0000-0000-0000-000000000000,type=service")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

return await Deployment.RunAsync(() =>
{
    var myRole = new PostgreSql.Role("my_role", new()
    {
        Name = "my_role",
        Login = true,
    });

    var workload = new PostgreSql.SecurityLabel("workload", new()
    {
        ObjectType = "role",
        ObjectName = myRole.Name,
        LabelProvider = "pgaadauth",
        Label = "aadauth,oid=00000000-0000-0000-0000-000000000000,type=service",
    });

});
package main

import (
	"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myRole, err := postgresql.NewRole(ctx, "my_role", &postgresql.RoleArgs{
			Name:  pulumi.String("my_role"),
			Login: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = postgresql.NewSecurityLabel(ctx, "workload", &postgresql.SecurityLabelArgs{
			ObjectType:    pulumi.String("role"),
			ObjectName:    myRole.Name,
			LabelProvider: pulumi.String("pgaadauth"),
			Label:         pulumi.String("aadauth,oid=00000000-0000-0000-0000-000000000000,type=service"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    postgresql = {
      source = "pulumi/postgresql"
    }
  }
}

resource "postgresql_role" "my_role" {
  name  = "my_role"
  login = true
}
resource "postgresql_securitylabel" "workload" {
  object_type    = "role"
  object_name    = postgresql_role.my_role.name
  label_provider = "pgaadauth"
  label          = "aadauth,oid=00000000-0000-0000-0000-000000000000,type=service"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.postgresql.Role;
import com.pulumi.postgresql.RoleArgs;
import com.pulumi.postgresql.SecurityLabel;
import com.pulumi.postgresql.SecurityLabelArgs;
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 myRole = new Role("myRole", RoleArgs.builder()
            .name("my_role")
            .login(true)
            .build());

        var workload = new SecurityLabel("workload", SecurityLabelArgs.builder()
            .objectType("role")
            .objectName(myRole.name())
            .labelProvider("pgaadauth")
            .label("aadauth,oid=00000000-0000-0000-0000-000000000000,type=service")
            .build());

    }
}
resources:
  myRole:
    type: postgresql:Role
    name: my_role
    properties:
      name: my_role
      login: true
  workload:
    type: postgresql:SecurityLabel
    properties:
      objectType: role
      objectName: ${myRole.name}
      labelProvider: pgaadauth
      label: aadauth,oid=00000000-0000-0000-0000-000000000000,type=service

Import

Security label is an attribute that can be added multiple times, so no import is needed, simply apply again.

Constructors

SecurityLabel(String name, {SecurityLabelArgs? args, CustomResourceOptions? options})
Creates a new SecurityLabel. name The Pulumi resource name. args Arguments used to configure this SecurityLabel. The set of arguments for SecurityLabel. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
label ↔ Output<String>
The value of the security label.
latefinal
labelProvider ↔ Output<String>
The name of the provider with which this label is to be associated.
latefinal
objectName ↔ Output<String>
The name of the object to be labeled. Names of objects that reside in schemas (tables, functions, etc.) can be schema-qualified.
latefinal
objectType ↔ Output<String>
The PostgreSQL object type to apply this security label to.
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, {SecurityLabelState? state}) → SecurityLabel
Gets an existing SecurityLabel resource's state with the given name and id.