Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. pgEdge
  3. API Docs
  4. Database
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

pgedge.Database

Explore with Pulumi AI

pgedge logo
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
pgEdge/pulumi-pgedge

    Manages a pgEdge database.

    Create Database Resource

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

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cluster_id: Optional[str] = None,
             nodes: Optional[Mapping[str, DatabaseNodesArgs]] = None,
             backups: Optional[DatabaseBackupsArgs] = None,
             config_version: Optional[str] = None,
             display_name: Optional[str] = None,
             extensions: Optional[DatabaseExtensionsArgs] = None,
             name: Optional[str] = None,
             options: Optional[Sequence[str]] = None,
             roles: Optional[Sequence[DatabaseRoleArgs]] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

    type: pgedge:Database
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 DatabaseArgs
    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 DatabaseArgs
    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 DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    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 databaseResource = new Pgedge.Database("databaseResource", new()
{
    ClusterId = "string",
    Nodes = 
    {
        { "string", new Pgedge.Inputs.DatabaseNodesArgs
        {
            Name = "string",
            Connection = new Pgedge.Inputs.DatabaseNodesConnectionArgs
            {
                Database = "string",
                ExternalIpAddress = "string",
                Host = "string",
                InternalHost = "string",
                InternalIpAddress = "string",
                Password = "string",
                Port = 0,
                Username = "string",
            },
            Extensions = new Pgedge.Inputs.DatabaseNodesExtensionsArgs
            {
                Errors = 
                {
                    { "string", "string" },
                },
                Installeds = new[]
                {
                    "string",
                },
            },
            Location = new Pgedge.Inputs.DatabaseNodesLocationArgs
            {
                City = "string",
                Code = "string",
                Country = "string",
                Latitude = 0,
                Longitude = 0,
                MetroCode = "string",
                Name = "string",
                PostalCode = "string",
                Region = "string",
                RegionCode = "string",
                Timezone = "string",
            },
            Region = new Pgedge.Inputs.DatabaseNodesRegionArgs
            {
                Active = false,
                AvailabilityZones = new[]
                {
                    "string",
                },
                Cloud = "string",
                Code = "string",
                Name = "string",
                Parent = "string",
            },
        } },
    },
    Backups = new Pgedge.Inputs.DatabaseBackupsArgs
    {
        Configs = new[]
        {
            new Pgedge.Inputs.DatabaseBackupsConfigArgs
            {
                Id = "string",
                NodeName = "string",
                Repositories = new[]
                {
                    new Pgedge.Inputs.DatabaseBackupsConfigRepositoryArgs
                    {
                        AzureAccount = "string",
                        AzureContainer = "string",
                        AzureEndpoint = "string",
                        BackupStoreId = "string",
                        BasePath = "string",
                        GcsBucket = "string",
                        GcsEndpoint = "string",
                        Id = "string",
                        RetentionFull = 0,
                        RetentionFullType = "string",
                        S3Bucket = "string",
                        S3Endpoint = "string",
                        S3Region = "string",
                        Type = "string",
                    },
                },
                Schedules = new[]
                {
                    new Pgedge.Inputs.DatabaseBackupsConfigScheduleArgs
                    {
                        CronExpression = "string",
                        Id = "string",
                        Type = "string",
                    },
                },
            },
        },
        Provider = "string",
    },
    ConfigVersion = "string",
    DisplayName = "string",
    Extensions = new Pgedge.Inputs.DatabaseExtensionsArgs
    {
        AutoManage = false,
        Availables = new[]
        {
            "string",
        },
        Requesteds = new[]
        {
            "string",
        },
    },
    Name = "string",
    Options = new[]
    {
        "string",
    },
    Roles = new[]
    {
        new Pgedge.Inputs.DatabaseRoleArgs
        {
            BypassRls = false,
            ConnectionLimit = 0,
            CreateDb = false,
            CreateRole = false,
            Inherit = false,
            Login = false,
            Name = "string",
            Replication = false,
            Superuser = false,
        },
    },
});

    example, err := pgedge.NewDatabase(ctx, "databaseResource", &pgedge.DatabaseArgs{
	ClusterId: pulumi.String("string"),
	Nodes: pgedge.DatabaseNodesMap{
		"string": &pgedge.DatabaseNodesArgs{
			Name: pulumi.String("string"),
			Connection: &pgedge.DatabaseNodesConnectionArgs{
				Database:          pulumi.String("string"),
				ExternalIpAddress: pulumi.String("string"),
				Host:              pulumi.String("string"),
				InternalHost:      pulumi.String("string"),
				InternalIpAddress: pulumi.String("string"),
				Password:          pulumi.String("string"),
				Port:              pulumi.Int(0),
				Username:          pulumi.String("string"),
			},
			Extensions: &pgedge.DatabaseNodesExtensionsArgs{
				Errors: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Installeds: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Location: &pgedge.DatabaseNodesLocationArgs{
				City:       pulumi.String("string"),
				Code:       pulumi.String("string"),
				Country:    pulumi.String("string"),
				Latitude:   pulumi.Float64(0),
				Longitude:  pulumi.Float64(0),
				MetroCode:  pulumi.String("string"),
				Name:       pulumi.String("string"),
				PostalCode: pulumi.String("string"),
				Region:     pulumi.String("string"),
				RegionCode: pulumi.String("string"),
				Timezone:   pulumi.String("string"),
			},
			Region: &pgedge.DatabaseNodesRegionArgs{
				Active: pulumi.Bool(false),
				AvailabilityZones: pulumi.StringArray{
					pulumi.String("string"),
				},
				Cloud:  pulumi.String("string"),
				Code:   pulumi.String("string"),
				Name:   pulumi.String("string"),
				Parent: pulumi.String("string"),
			},
		},
	},
	Backups: &pgedge.DatabaseBackupsArgs{
		Configs: pgedge.DatabaseBackupsConfigArray{
			&pgedge.DatabaseBackupsConfigArgs{
				Id:       pulumi.String("string"),
				NodeName: pulumi.String("string"),
				Repositories: pgedge.DatabaseBackupsConfigRepositoryArray{
					&pgedge.DatabaseBackupsConfigRepositoryArgs{
						AzureAccount:      pulumi.String("string"),
						AzureContainer:    pulumi.String("string"),
						AzureEndpoint:     pulumi.String("string"),
						BackupStoreId:     pulumi.String("string"),
						BasePath:          pulumi.String("string"),
						GcsBucket:         pulumi.String("string"),
						GcsEndpoint:       pulumi.String("string"),
						Id:                pulumi.String("string"),
						RetentionFull:     pulumi.Int(0),
						RetentionFullType: pulumi.String("string"),
						S3Bucket:          pulumi.String("string"),
						S3Endpoint:        pulumi.String("string"),
						S3Region:          pulumi.String("string"),
						Type:              pulumi.String("string"),
					},
				},
				Schedules: pgedge.DatabaseBackupsConfigScheduleArray{
					&pgedge.DatabaseBackupsConfigScheduleArgs{
						CronExpression: pulumi.String("string"),
						Id:             pulumi.String("string"),
						Type:           pulumi.String("string"),
					},
				},
			},
		},
		Provider: pulumi.String("string"),
	},
	ConfigVersion: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	Extensions: &pgedge.DatabaseExtensionsArgs{
		AutoManage: pulumi.Bool(false),
		Availables: pulumi.StringArray{
			pulumi.String("string"),
		},
		Requesteds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Options: pulumi.StringArray{
		pulumi.String("string"),
	},
	Roles: pgedge.DatabaseRoleArray{
		&pgedge.DatabaseRoleArgs{
			BypassRls:       pulumi.Bool(false),
			ConnectionLimit: pulumi.Int(0),
			CreateDb:        pulumi.Bool(false),
			CreateRole:      pulumi.Bool(false),
			Inherit:         pulumi.Bool(false),
			Login:           pulumi.Bool(false),
			Name:            pulumi.String("string"),
			Replication:     pulumi.Bool(false),
			Superuser:       pulumi.Bool(false),
		},
	},
})

    var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
    .clusterId("string")
    .nodes(Map.of("string", Map.ofEntries(
        Map.entry("name", "string"),
        Map.entry("connection", Map.ofEntries(
            Map.entry("database", "string"),
            Map.entry("externalIpAddress", "string"),
            Map.entry("host", "string"),
            Map.entry("internalHost", "string"),
            Map.entry("internalIpAddress", "string"),
            Map.entry("password", "string"),
            Map.entry("port", 0),
            Map.entry("username", "string")
        )),
        Map.entry("extensions", Map.ofEntries(
            Map.entry("errors", Map.of("string", "string")),
            Map.entry("installeds", "string")
        )),
        Map.entry("location", Map.ofEntries(
            Map.entry("city", "string"),
            Map.entry("code", "string"),
            Map.entry("country", "string"),
            Map.entry("latitude", 0),
            Map.entry("longitude", 0),
            Map.entry("metroCode", "string"),
            Map.entry("name", "string"),
            Map.entry("postalCode", "string"),
            Map.entry("region", "string"),
            Map.entry("regionCode", "string"),
            Map.entry("timezone", "string")
        )),
        Map.entry("region", Map.ofEntries(
            Map.entry("active", false),
            Map.entry("availabilityZones", "string"),
            Map.entry("cloud", "string"),
            Map.entry("code", "string"),
            Map.entry("name", "string"),
            Map.entry("parent", "string")
        ))
    )))
    .backups(DatabaseBackupsArgs.builder()
        .configs(DatabaseBackupsConfigArgs.builder()
            .id("string")
            .nodeName("string")
            .repositories(DatabaseBackupsConfigRepositoryArgs.builder()
                .azureAccount("string")
                .azureContainer("string")
                .azureEndpoint("string")
                .backupStoreId("string")
                .basePath("string")
                .gcsBucket("string")
                .gcsEndpoint("string")
                .id("string")
                .retentionFull(0)
                .retentionFullType("string")
                .s3Bucket("string")
                .s3Endpoint("string")
                .s3Region("string")
                .type("string")
                .build())
            .schedules(DatabaseBackupsConfigScheduleArgs.builder()
                .cronExpression("string")
                .id("string")
                .type("string")
                .build())
            .build())
        .provider("string")
        .build())
    .configVersion("string")
    .displayName("string")
    .extensions(DatabaseExtensionsArgs.builder()
        .autoManage(false)
        .availables("string")
        .requesteds("string")
        .build())
    .name("string")
    .options("string")
    .roles(DatabaseRoleArgs.builder()
        .bypassRls(false)
        .connectionLimit(0)
        .createDb(false)
        .createRole(false)
        .inherit(false)
        .login(false)
        .name("string")
        .replication(false)
        .superuser(false)
        .build())
    .build());

    database_resource = pgedge.Database("databaseResource",
    cluster_id="string",
    nodes={
        "string": {
            "name": "string",
            "connection": {
                "database": "string",
                "external_ip_address": "string",
                "host": "string",
                "internal_host": "string",
                "internal_ip_address": "string",
                "password": "string",
                "port": 0,
                "username": "string",
            },
            "extensions": {
                "errors": {
                    "string": "string",
                },
                "installeds": ["string"],
            },
            "location": {
                "city": "string",
                "code": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "metro_code": "string",
                "name": "string",
                "postal_code": "string",
                "region": "string",
                "region_code": "string",
                "timezone": "string",
            },
            "region": {
                "active": False,
                "availability_zones": ["string"],
                "cloud": "string",
                "code": "string",
                "name": "string",
                "parent": "string",
            },
        },
    },
    backups={
        "configs": [{
            "id": "string",
            "node_name": "string",
            "repositories": [{
                "azure_account": "string",
                "azure_container": "string",
                "azure_endpoint": "string",
                "backup_store_id": "string",
                "base_path": "string",
                "gcs_bucket": "string",
                "gcs_endpoint": "string",
                "id": "string",
                "retention_full": 0,
                "retention_full_type": "string",
                "s3_bucket": "string",
                "s3_endpoint": "string",
                "s3_region": "string",
                "type": "string",
            }],
            "schedules": [{
                "cron_expression": "string",
                "id": "string",
                "type": "string",
            }],
        }],
        "provider": "string",
    },
    config_version="string",
    display_name="string",
    extensions={
        "auto_manage": False,
        "availables": ["string"],
        "requesteds": ["string"],
    },
    name="string",
    options=["string"],
    roles=[{
        "bypass_rls": False,
        "connection_limit": 0,
        "create_db": False,
        "create_role": False,
        "inherit": False,
        "login": False,
        "name": "string",
        "replication": False,
        "superuser": False,
    }])

    const databaseResource = new pgedge.Database("databaseResource", {
    clusterId: "string",
    nodes: {
        string: {
            name: "string",
            connection: {
                database: "string",
                externalIpAddress: "string",
                host: "string",
                internalHost: "string",
                internalIpAddress: "string",
                password: "string",
                port: 0,
                username: "string",
            },
            extensions: {
                errors: {
                    string: "string",
                },
                installeds: ["string"],
            },
            location: {
                city: "string",
                code: "string",
                country: "string",
                latitude: 0,
                longitude: 0,
                metroCode: "string",
                name: "string",
                postalCode: "string",
                region: "string",
                regionCode: "string",
                timezone: "string",
            },
            region: {
                active: false,
                availabilityZones: ["string"],
                cloud: "string",
                code: "string",
                name: "string",
                parent: "string",
            },
        },
    },
    backups: {
        configs: [{
            id: "string",
            nodeName: "string",
            repositories: [{
                azureAccount: "string",
                azureContainer: "string",
                azureEndpoint: "string",
                backupStoreId: "string",
                basePath: "string",
                gcsBucket: "string",
                gcsEndpoint: "string",
                id: "string",
                retentionFull: 0,
                retentionFullType: "string",
                s3Bucket: "string",
                s3Endpoint: "string",
                s3Region: "string",
                type: "string",
            }],
            schedules: [{
                cronExpression: "string",
                id: "string",
                type: "string",
            }],
        }],
        provider: "string",
    },
    configVersion: "string",
    displayName: "string",
    extensions: {
        autoManage: false,
        availables: ["string"],
        requesteds: ["string"],
    },
    name: "string",
    options: ["string"],
    roles: [{
        bypassRls: false,
        connectionLimit: 0,
        createDb: false,
        createRole: false,
        inherit: false,
        login: false,
        name: "string",
        replication: false,
        superuser: false,
    }],
});

    type: pgedge:Database
properties:
    backups:
        configs:
            - id: string
              nodeName: string
              repositories:
                - azureAccount: string
                  azureContainer: string
                  azureEndpoint: string
                  backupStoreId: string
                  basePath: string
                  gcsBucket: string
                  gcsEndpoint: string
                  id: string
                  retentionFull: 0
                  retentionFullType: string
                  s3Bucket: string
                  s3Endpoint: string
                  s3Region: string
                  type: string
              schedules:
                - cronExpression: string
                  id: string
                  type: string
        provider: string
    clusterId: string
    configVersion: string
    displayName: string
    extensions:
        autoManage: false
        availables:
            - string
        requesteds:
            - string
    name: string
    nodes:
        string:
            connection:
                database: string
                externalIpAddress: string
                host: string
                internalHost: string
                internalIpAddress: string
                password: string
                port: 0
                username: string
            extensions:
                errors:
                    string: string
                installeds:
                    - string
            location:
                city: string
                code: string
                country: string
                latitude: 0
                longitude: 0
                metroCode: string
                name: string
                postalCode: string
                region: string
                regionCode: string
                timezone: string
            name: string
            region:
                active: false
                availabilityZones:
                    - string
                cloud: string
                code: string
                name: string
                parent: string
    options:
        - string
    roles:
        - bypassRls: false
          connectionLimit: 0
          createDb: false
          createRole: false
          inherit: false
          login: false
          name: string
          replication: false
          superuser: false

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

    ClusterId string
    The ID of the cluster this database belongs to.
    Nodes Dictionary<string, Pgedge.Pgedge.Inputs.DatabaseNodesArgs>
    Map of nodes in the database.
    Backups Pgedge.Pgedge.Inputs.DatabaseBackups
    Backup configuration for the database.
    ConfigVersion string
    The configuration version of the database.
    DisplayName string
    Display name for the database. Maximum length is 25 characters.
    Extensions Pgedge.Pgedge.Inputs.DatabaseExtensions
    Extensions configuration for the database.
    Name string
    The name of the database.
    Options List<string>
    A list of options for the database.
    Roles List<Pgedge.Pgedge.Inputs.DatabaseRole>
    List of roles in the database.
    ClusterId string
    The ID of the cluster this database belongs to.
    Nodes map[string]DatabaseNodesArgs
    Map of nodes in the database.
    Backups DatabaseBackupsArgs
    Backup configuration for the database.
    ConfigVersion string
    The configuration version of the database.
    DisplayName string
    Display name for the database. Maximum length is 25 characters.
    Extensions DatabaseExtensionsArgs
    Extensions configuration for the database.
    Name string
    The name of the database.
    Options []string
    A list of options for the database.
    Roles []DatabaseRoleArgs
    List of roles in the database.
    clusterId String
    The ID of the cluster this database belongs to.
    nodes Map<String,DatabaseNodesArgs>
    Map of nodes in the database.
    backups DatabaseBackups
    Backup configuration for the database.
    configVersion String
    The configuration version of the database.
    displayName String
    Display name for the database. Maximum length is 25 characters.
    extensions DatabaseExtensions
    Extensions configuration for the database.
    name String
    The name of the database.
    options List<String>
    A list of options for the database.
    roles List<DatabaseRole>
    List of roles in the database.
    clusterId string
    The ID of the cluster this database belongs to.
    nodes {[key: string]: DatabaseNodesArgs}
    Map of nodes in the database.
    backups DatabaseBackups
    Backup configuration for the database.
    configVersion string
    The configuration version of the database.
    displayName string
    Display name for the database. Maximum length is 25 characters.
    extensions DatabaseExtensions
    Extensions configuration for the database.
    name string
    The name of the database.
    options string[]
    A list of options for the database.
    roles DatabaseRole[]
    List of roles in the database.
    cluster_id str
    The ID of the cluster this database belongs to.
    nodes Mapping[str, DatabaseNodesArgs]
    Map of nodes in the database.
    backups DatabaseBackupsArgs
    Backup configuration for the database.
    config_version str
    The configuration version of the database.
    display_name str
    Display name for the database. Maximum length is 25 characters.
    extensions DatabaseExtensionsArgs
    Extensions configuration for the database.
    name str
    The name of the database.
    options Sequence[str]
    A list of options for the database.
    roles Sequence[DatabaseRoleArgs]
    List of roles in the database.
    clusterId String
    The ID of the cluster this database belongs to.
    nodes Map<Property Map>
    Map of nodes in the database.
    backups Property Map
    Backup configuration for the database.
    configVersion String
    The configuration version of the database.
    displayName String
    Display name for the database. Maximum length is 25 characters.
    extensions Property Map
    Extensions configuration for the database.
    name String
    The name of the database.
    options List<String>
    A list of options for the database.
    roles List<Property Map>
    List of roles in the database.

    Outputs

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

    Components List<Pgedge.Pgedge.Outputs.DatabaseComponent>
    List of components in the database.
    CreatedAt string
    The timestamp when the database was created.
    Domain string
    The domain associated with the database.
    Id string
    The provider-assigned unique ID for this managed resource.
    PgVersion string
    The PostgreSQL version of the database.
    Status string
    The current status of the database.
    Components []DatabaseComponent
    List of components in the database.
    CreatedAt string
    The timestamp when the database was created.
    Domain string
    The domain associated with the database.
    Id string
    The provider-assigned unique ID for this managed resource.
    PgVersion string
    The PostgreSQL version of the database.
    Status string
    The current status of the database.
    components List<DatabaseComponent>
    List of components in the database.
    createdAt String
    The timestamp when the database was created.
    domain String
    The domain associated with the database.
    id String
    The provider-assigned unique ID for this managed resource.
    pgVersion String
    The PostgreSQL version of the database.
    status String
    The current status of the database.
    components DatabaseComponent[]
    List of components in the database.
    createdAt string
    The timestamp when the database was created.
    domain string
    The domain associated with the database.
    id string
    The provider-assigned unique ID for this managed resource.
    pgVersion string
    The PostgreSQL version of the database.
    status string
    The current status of the database.
    components Sequence[DatabaseComponent]
    List of components in the database.
    created_at str
    The timestamp when the database was created.
    domain str
    The domain associated with the database.
    id str
    The provider-assigned unique ID for this managed resource.
    pg_version str
    The PostgreSQL version of the database.
    status str
    The current status of the database.
    components List<Property Map>
    List of components in the database.
    createdAt String
    The timestamp when the database was created.
    domain String
    The domain associated with the database.
    id String
    The provider-assigned unique ID for this managed resource.
    pgVersion String
    The PostgreSQL version of the database.
    status String
    The current status of the database.

    Look up Existing Database Resource

    Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backups: Optional[DatabaseBackupsArgs] = None,
        cluster_id: Optional[str] = None,
        components: Optional[Sequence[DatabaseComponentArgs]] = None,
        config_version: Optional[str] = None,
        created_at: Optional[str] = None,
        display_name: Optional[str] = None,
        domain: Optional[str] = None,
        extensions: Optional[DatabaseExtensionsArgs] = None,
        name: Optional[str] = None,
        nodes: Optional[Mapping[str, DatabaseNodesArgs]] = None,
        options: Optional[Sequence[str]] = None,
        pg_version: Optional[str] = None,
        roles: Optional[Sequence[DatabaseRoleArgs]] = None,
        status: Optional[str] = None) -> Database
    func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
    public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
    public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
    resources:  _:    type: pgedge:Database    get:      id: ${id}
    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:
    Backups Pgedge.Pgedge.Inputs.DatabaseBackups
    Backup configuration for the database.
    ClusterId string
    The ID of the cluster this database belongs to.
    Components List<Pgedge.Pgedge.Inputs.DatabaseComponent>
    List of components in the database.
    ConfigVersion string
    The configuration version of the database.
    CreatedAt string
    The timestamp when the database was created.
    DisplayName string
    Display name for the database. Maximum length is 25 characters.
    Domain string
    The domain associated with the database.
    Extensions Pgedge.Pgedge.Inputs.DatabaseExtensions
    Extensions configuration for the database.
    Name string
    The name of the database.
    Nodes Dictionary<string, Pgedge.Pgedge.Inputs.DatabaseNodesArgs>
    Map of nodes in the database.
    Options List<string>
    A list of options for the database.
    PgVersion string
    The PostgreSQL version of the database.
    Roles List<Pgedge.Pgedge.Inputs.DatabaseRole>
    List of roles in the database.
    Status string
    The current status of the database.
    Backups DatabaseBackupsArgs
    Backup configuration for the database.
    ClusterId string
    The ID of the cluster this database belongs to.
    Components []DatabaseComponentArgs
    List of components in the database.
    ConfigVersion string
    The configuration version of the database.
    CreatedAt string
    The timestamp when the database was created.
    DisplayName string
    Display name for the database. Maximum length is 25 characters.
    Domain string
    The domain associated with the database.
    Extensions DatabaseExtensionsArgs
    Extensions configuration for the database.
    Name string
    The name of the database.
    Nodes map[string]DatabaseNodesArgs
    Map of nodes in the database.
    Options []string
    A list of options for the database.
    PgVersion string
    The PostgreSQL version of the database.
    Roles []DatabaseRoleArgs
    List of roles in the database.
    Status string
    The current status of the database.
    backups DatabaseBackups
    Backup configuration for the database.
    clusterId String
    The ID of the cluster this database belongs to.
    components List<DatabaseComponent>
    List of components in the database.
    configVersion String
    The configuration version of the database.
    createdAt String
    The timestamp when the database was created.
    displayName String
    Display name for the database. Maximum length is 25 characters.
    domain String
    The domain associated with the database.
    extensions DatabaseExtensions
    Extensions configuration for the database.
    name String
    The name of the database.
    nodes Map<String,DatabaseNodesArgs>
    Map of nodes in the database.
    options List<String>
    A list of options for the database.
    pgVersion String
    The PostgreSQL version of the database.
    roles List<DatabaseRole>
    List of roles in the database.
    status String
    The current status of the database.
    backups DatabaseBackups
    Backup configuration for the database.
    clusterId string
    The ID of the cluster this database belongs to.
    components DatabaseComponent[]
    List of components in the database.
    configVersion string
    The configuration version of the database.
    createdAt string
    The timestamp when the database was created.
    displayName string
    Display name for the database. Maximum length is 25 characters.
    domain string
    The domain associated with the database.
    extensions DatabaseExtensions
    Extensions configuration for the database.
    name string
    The name of the database.
    nodes {[key: string]: DatabaseNodesArgs}
    Map of nodes in the database.
    options string[]
    A list of options for the database.
    pgVersion string
    The PostgreSQL version of the database.
    roles DatabaseRole[]
    List of roles in the database.
    status string
    The current status of the database.
    backups DatabaseBackupsArgs
    Backup configuration for the database.
    cluster_id str
    The ID of the cluster this database belongs to.
    components Sequence[DatabaseComponentArgs]
    List of components in the database.
    config_version str
    The configuration version of the database.
    created_at str
    The timestamp when the database was created.
    display_name str
    Display name for the database. Maximum length is 25 characters.
    domain str
    The domain associated with the database.
    extensions DatabaseExtensionsArgs
    Extensions configuration for the database.
    name str
    The name of the database.
    nodes Mapping[str, DatabaseNodesArgs]
    Map of nodes in the database.
    options Sequence[str]
    A list of options for the database.
    pg_version str
    The PostgreSQL version of the database.
    roles Sequence[DatabaseRoleArgs]
    List of roles in the database.
    status str
    The current status of the database.
    backups Property Map
    Backup configuration for the database.
    clusterId String
    The ID of the cluster this database belongs to.
    components List<Property Map>
    List of components in the database.
    configVersion String
    The configuration version of the database.
    createdAt String
    The timestamp when the database was created.
    displayName String
    Display name for the database. Maximum length is 25 characters.
    domain String
    The domain associated with the database.
    extensions Property Map
    Extensions configuration for the database.
    name String
    The name of the database.
    nodes Map<Property Map>
    Map of nodes in the database.
    options List<String>
    A list of options for the database.
    pgVersion String
    The PostgreSQL version of the database.
    roles List<Property Map>
    List of roles in the database.
    status String
    The current status of the database.

    Supporting Types

    DatabaseBackups, DatabaseBackupsArgs

    Configs List<Pgedge.Pgedge.Inputs.DatabaseBackupsConfig>
    List of backup configurations.
    Provider string
    The backup provider.
    Configs []DatabaseBackupsConfig
    List of backup configurations.
    Provider string
    The backup provider.
    configs List<DatabaseBackupsConfig>
    List of backup configurations.
    provider String
    The backup provider.
    configs DatabaseBackupsConfig[]
    List of backup configurations.
    provider string
    The backup provider.
    configs Sequence[DatabaseBackupsConfig]
    List of backup configurations.
    provider str
    The backup provider.
    configs List<Property Map>
    List of backup configurations.
    provider String
    The backup provider.

    DatabaseBackupsConfig, DatabaseBackupsConfigArgs

    Id string
    Unique identifier for the backup config.
    NodeName string
    Name of the node.
    Repositories List<Pgedge.Pgedge.Inputs.DatabaseBackupsConfigRepository>
    List of backup repositories.
    Schedules List<Pgedge.Pgedge.Inputs.DatabaseBackupsConfigSchedule>
    List of backup schedules.
    Id string
    Unique identifier for the backup config.
    NodeName string
    Name of the node.
    Repositories []DatabaseBackupsConfigRepository
    List of backup repositories.
    Schedules []DatabaseBackupsConfigSchedule
    List of backup schedules.
    id String
    Unique identifier for the backup config.
    nodeName String
    Name of the node.
    repositories List<DatabaseBackupsConfigRepository>
    List of backup repositories.
    schedules List<DatabaseBackupsConfigSchedule>
    List of backup schedules.
    id string
    Unique identifier for the backup config.
    nodeName string
    Name of the node.
    repositories DatabaseBackupsConfigRepository[]
    List of backup repositories.
    schedules DatabaseBackupsConfigSchedule[]
    List of backup schedules.
    id str
    Unique identifier for the backup config.
    node_name str
    Name of the node.
    repositories Sequence[DatabaseBackupsConfigRepository]
    List of backup repositories.
    schedules Sequence[DatabaseBackupsConfigSchedule]
    List of backup schedules.
    id String
    Unique identifier for the backup config.
    nodeName String
    Name of the node.
    repositories List<Property Map>
    List of backup repositories.
    schedules List<Property Map>
    List of backup schedules.

    DatabaseBackupsConfigRepository, DatabaseBackupsConfigRepositoryArgs

    AzureAccount string
    Azure account for azure-type repositories.
    AzureContainer string
    Azure container for azure-type repositories.
    AzureEndpoint string
    Azure endpoint for azure-type repositories.
    BackupStoreId string
    ID of the backup store to use. If specified, other fields will be automatically populated.
    BasePath string
    Base path for the repository.
    GcsBucket string
    GCS bucket name for gcs-type repositories.
    GcsEndpoint string
    GCS endpoint for gcs-type repositories.
    Id string
    Unique identifier for the backup config.
    RetentionFull int
    Retention period for full backups.
    RetentionFullType string
    Type of retention for full backups.
    S3Bucket string
    S3 bucket name for s3-type repositories.
    S3Endpoint string
    S3 endpoint for s3-type repositories.
    S3Region string
    S3 region for s3-type repositories.
    Type string
    Repository type (e.g., s3, gcs, azure).
    AzureAccount string
    Azure account for azure-type repositories.
    AzureContainer string
    Azure container for azure-type repositories.
    AzureEndpoint string
    Azure endpoint for azure-type repositories.
    BackupStoreId string
    ID of the backup store to use. If specified, other fields will be automatically populated.
    BasePath string
    Base path for the repository.
    GcsBucket string
    GCS bucket name for gcs-type repositories.
    GcsEndpoint string
    GCS endpoint for gcs-type repositories.
    Id string
    Unique identifier for the backup config.
    RetentionFull int
    Retention period for full backups.
    RetentionFullType string
    Type of retention for full backups.
    S3Bucket string
    S3 bucket name for s3-type repositories.
    S3Endpoint string
    S3 endpoint for s3-type repositories.
    S3Region string
    S3 region for s3-type repositories.
    Type string
    Repository type (e.g., s3, gcs, azure).
    azureAccount String
    Azure account for azure-type repositories.
    azureContainer String
    Azure container for azure-type repositories.
    azureEndpoint String
    Azure endpoint for azure-type repositories.
    backupStoreId String
    ID of the backup store to use. If specified, other fields will be automatically populated.
    basePath String
    Base path for the repository.
    gcsBucket String
    GCS bucket name for gcs-type repositories.
    gcsEndpoint String
    GCS endpoint for gcs-type repositories.
    id String
    Unique identifier for the backup config.
    retentionFull Integer
    Retention period for full backups.
    retentionFullType String
    Type of retention for full backups.
    s3Bucket String
    S3 bucket name for s3-type repositories.
    s3Endpoint String
    S3 endpoint for s3-type repositories.
    s3Region String
    S3 region for s3-type repositories.
    type String
    Repository type (e.g., s3, gcs, azure).
    azureAccount string
    Azure account for azure-type repositories.
    azureContainer string
    Azure container for azure-type repositories.
    azureEndpoint string
    Azure endpoint for azure-type repositories.
    backupStoreId string
    ID of the backup store to use. If specified, other fields will be automatically populated.
    basePath string
    Base path for the repository.
    gcsBucket string
    GCS bucket name for gcs-type repositories.
    gcsEndpoint string
    GCS endpoint for gcs-type repositories.
    id string
    Unique identifier for the backup config.
    retentionFull number
    Retention period for full backups.
    retentionFullType string
    Type of retention for full backups.
    s3Bucket string
    S3 bucket name for s3-type repositories.
    s3Endpoint string
    S3 endpoint for s3-type repositories.
    s3Region string
    S3 region for s3-type repositories.
    type string
    Repository type (e.g., s3, gcs, azure).
    azure_account str
    Azure account for azure-type repositories.
    azure_container str
    Azure container for azure-type repositories.
    azure_endpoint str
    Azure endpoint for azure-type repositories.
    backup_store_id str
    ID of the backup store to use. If specified, other fields will be automatically populated.
    base_path str
    Base path for the repository.
    gcs_bucket str
    GCS bucket name for gcs-type repositories.
    gcs_endpoint str
    GCS endpoint for gcs-type repositories.
    id str
    Unique identifier for the backup config.
    retention_full int
    Retention period for full backups.
    retention_full_type str
    Type of retention for full backups.
    s3_bucket str
    S3 bucket name for s3-type repositories.
    s3_endpoint str
    S3 endpoint for s3-type repositories.
    s3_region str
    S3 region for s3-type repositories.
    type str
    Repository type (e.g., s3, gcs, azure).
    azureAccount String
    Azure account for azure-type repositories.
    azureContainer String
    Azure container for azure-type repositories.
    azureEndpoint String
    Azure endpoint for azure-type repositories.
    backupStoreId String
    ID of the backup store to use. If specified, other fields will be automatically populated.
    basePath String
    Base path for the repository.
    gcsBucket String
    GCS bucket name for gcs-type repositories.
    gcsEndpoint String
    GCS endpoint for gcs-type repositories.
    id String
    Unique identifier for the backup config.
    retentionFull Number
    Retention period for full backups.
    retentionFullType String
    Type of retention for full backups.
    s3Bucket String
    S3 bucket name for s3-type repositories.
    s3Endpoint String
    S3 endpoint for s3-type repositories.
    s3Region String
    S3 region for s3-type repositories.
    type String
    Repository type (e.g., s3, gcs, azure).

    DatabaseBackupsConfigSchedule, DatabaseBackupsConfigScheduleArgs

    CronExpression string
    Cron expression for the schedule.
    Id string
    Unique identifier for the backup config.
    Type string
    Repository type (e.g., s3, gcs, azure).
    CronExpression string
    Cron expression for the schedule.
    Id string
    Unique identifier for the backup config.
    Type string
    Repository type (e.g., s3, gcs, azure).
    cronExpression String
    Cron expression for the schedule.
    id String
    Unique identifier for the backup config.
    type String
    Repository type (e.g., s3, gcs, azure).
    cronExpression string
    Cron expression for the schedule.
    id string
    Unique identifier for the backup config.
    type string
    Repository type (e.g., s3, gcs, azure).
    cron_expression str
    Cron expression for the schedule.
    id str
    Unique identifier for the backup config.
    type str
    Repository type (e.g., s3, gcs, azure).
    cronExpression String
    Cron expression for the schedule.
    id String
    Unique identifier for the backup config.
    type String
    Repository type (e.g., s3, gcs, azure).

    DatabaseComponent, DatabaseComponentArgs

    Id string
    Name string
    ReleaseDate string
    Status string
    Version string
    Id string
    Name string
    ReleaseDate string
    Status string
    Version string
    id String
    name String
    releaseDate String
    status String
    version String
    id string
    name string
    releaseDate string
    status string
    version string
    id String
    name String
    releaseDate String
    status String
    version String

    DatabaseExtensions, DatabaseExtensionsArgs

    AutoManage bool
    Availables List<string>
    Requesteds List<string>
    AutoManage bool
    Availables []string
    Requesteds []string
    autoManage Boolean
    availables List<String>
    requesteds List<String>
    autoManage boolean
    availables string[]
    requesteds string[]
    auto_manage bool
    availables Sequence[str]
    requesteds Sequence[str]
    autoManage Boolean
    availables List<String>
    requesteds List<String>

    DatabaseNodes, DatabaseNodesArgs

    DatabaseNodesConnection, DatabaseNodesConnectionArgs

    Database string
    ExternalIpAddress string
    Host string
    InternalHost string
    InternalIpAddress string
    Password string
    Port int
    Username string
    Database string
    ExternalIpAddress string
    Host string
    InternalHost string
    InternalIpAddress string
    Password string
    Port int
    Username string
    database String
    externalIpAddress String
    host String
    internalHost String
    internalIpAddress String
    password String
    port Integer
    username String
    database string
    externalIpAddress string
    host string
    internalHost string
    internalIpAddress string
    password string
    port number
    username string
    database String
    externalIpAddress String
    host String
    internalHost String
    internalIpAddress String
    password String
    port Number
    username String

    DatabaseNodesExtensions, DatabaseNodesExtensionsArgs

    Errors Dictionary<string, string>
    Installeds List<string>
    Errors map[string]string
    Installeds []string
    errors Map<String,String>
    installeds List<String>
    errors {[key: string]: string}
    installeds string[]
    errors Mapping[str, str]
    installeds Sequence[str]
    errors Map<String>
    installeds List<String>

    DatabaseNodesLocation, DatabaseNodesLocationArgs

    City string
    Code string
    Country string
    Latitude double
    Longitude double
    MetroCode string
    Name string
    PostalCode string
    Region string
    RegionCode string
    Timezone string
    City string
    Code string
    Country string
    Latitude float64
    Longitude float64
    MetroCode string
    Name string
    PostalCode string
    Region string
    RegionCode string
    Timezone string
    city String
    code String
    country String
    latitude Double
    longitude Double
    metroCode String
    name String
    postalCode String
    region String
    regionCode String
    timezone String
    city string
    code string
    country string
    latitude number
    longitude number
    metroCode string
    name string
    postalCode string
    region string
    regionCode string
    timezone string
    city String
    code String
    country String
    latitude Number
    longitude Number
    metroCode String
    name String
    postalCode String
    region String
    regionCode String
    timezone String

    DatabaseNodesRegion, DatabaseNodesRegionArgs

    Active bool
    AvailabilityZones List<string>
    Cloud string
    Code string
    Name string
    Parent string
    Active bool
    AvailabilityZones []string
    Cloud string
    Code string
    Name string
    Parent string
    active Boolean
    availabilityZones List<String>
    cloud String
    code String
    name String
    parent String
    active boolean
    availabilityZones string[]
    cloud string
    code string
    name string
    parent string
    active bool
    availability_zones Sequence[str]
    cloud str
    code str
    name str
    parent str
    active Boolean
    availabilityZones List<String>
    cloud String
    code String
    name String
    parent String

    DatabaseRole, DatabaseRoleArgs

    bypassRls Boolean
    connectionLimit Integer
    createDb Boolean
    createRole Boolean
    inherit Boolean
    login Boolean
    name String
    replication Boolean
    superuser Boolean
    bypassRls boolean
    connectionLimit number
    createDb boolean
    createRole boolean
    inherit boolean
    login boolean
    name string
    replication boolean
    superuser boolean
    bypassRls Boolean
    connectionLimit Number
    createDb Boolean
    createRole Boolean
    inherit Boolean
    login Boolean
    name String
    replication Boolean
    superuser Boolean

    Package Details

    Repository
    pgedge pgEdge/pulumi-pgedge
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pgedge Terraform Provider.
    pgedge logo
    pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge
    pgEdge/pulumi-pgedge