com.pulumi.linode.DatabasePostgresql Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of linode Show documentation
Show all versions of linode Show documentation
A Pulumi package for creating and managing linode cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.linode;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.linode.DatabasePostgresqlArgs;
import com.pulumi.linode.Utilities;
import com.pulumi.linode.inputs.DatabasePostgresqlState;
import com.pulumi.linode.outputs.DatabasePostgresqlUpdates;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a Linode PostgreSQL Database resource. This can be used to create, modify, and delete Linode PostgreSQL Databases.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instances).
*
* Please keep in mind that Managed Databases can take up to an hour to provision.
*
* ## Example Usage
*
* Creating a simple PostgreSQL database instance:
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.linode.DatabasePostgresql;
* import com.pulumi.linode.DatabasePostgresqlArgs;
* 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 foobar = new DatabasePostgresql("foobar", DatabasePostgresqlArgs.builder()
* .label("mydatabase")
* .engineId("postgresql/13.2")
* .region("us-southeast")
* .type("g6-nanode-1")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* Creating a complex PostgreSQL database instance:
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.linode.DatabasePostgresql;
* import com.pulumi.linode.DatabasePostgresqlArgs;
* import com.pulumi.linode.inputs.DatabasePostgresqlUpdatesArgs;
* 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 foobar = new DatabasePostgresql("foobar", DatabasePostgresqlArgs.builder()
* .label("mydatabase")
* .engineId("postgresql/13.2")
* .region("us-southeast")
* .type("g6-nanode-1")
* .allowLists("0.0.0.0/0")
* .clusterSize(3)
* .encrypted(true)
* .replicationType("semi_synch")
* .replicationCommitType("remote_write")
* .sslConnection(true)
* .updates(DatabasePostgresqlUpdatesArgs.builder()
* .dayOfWeek("saturday")
* .duration(1)
* .frequency("monthly")
* .hourOfDay(22)
* .weekOfMonth(2)
* .build())
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## updates
*
* The following arguments are supported in the `updates` specification block:
*
* * `day_of_week` - (Required) The day to perform maintenance. (`monday`, `tuesday`, ...)
*
* * `duration` - (Required) The maximum maintenance window time in hours. (`1`..`3`)
*
* * `frequency` - (Required) Whether maintenance occurs on a weekly or monthly basis. (`weekly`, `monthly`)
*
* * `hour_of_day` - (Required) The hour to begin maintenance based in UTC time. (`0`..`23`)
*
* * `week_of_month` - (Optional) The week of the month to perform monthly frequency updates. Required for `monthly` frequency updates. (`1`..`4`)
*
* ## Import
*
* Linode PostgreSQL Databases can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import linode:index/databasePostgresql:DatabasePostgresql foobar 1234567
* ```
*
*/
@ResourceType(type="linode:index/databasePostgresql:DatabasePostgresql")
public class DatabasePostgresql extends com.pulumi.resources.CustomResource {
/**
* A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use `linode.DatabaseAccessControls` to manage your allow list separately.
*
*/
@Export(name="allowLists", refs={List.class,String.class}, tree="[0,1]")
private Output> allowLists;
/**
* @return A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. Use `linode.DatabaseAccessControls` to manage your allow list separately.
*
*/
public Output> allowLists() {
return this.allowLists;
}
/**
* The base64-encoded SSL CA certificate for the Managed Database instance.
*
*/
@Export(name="caCert", refs={String.class}, tree="[0]")
private Output caCert;
/**
* @return The base64-encoded SSL CA certificate for the Managed Database instance.
*
*/
public Output caCert() {
return this.caCert;
}
/**
* The number of Linode Instance nodes deployed to the Managed Database. (default `1`)
*
*/
@Export(name="clusterSize", refs={Integer.class}, tree="[0]")
private Output clusterSize;
/**
* @return The number of Linode Instance nodes deployed to the Managed Database. (default `1`)
*
*/
public Output> clusterSize() {
return Codegen.optional(this.clusterSize);
}
/**
* When this Managed Database was created.
*
*/
@Export(name="created", refs={String.class}, tree="[0]")
private Output created;
/**
* @return When this Managed Database was created.
*
*/
public Output created() {
return this.created;
}
/**
* Whether the Managed Databases is encrypted. (default `false`)
*
*/
@Export(name="encrypted", refs={Boolean.class}, tree="[0]")
private Output encrypted;
/**
* @return Whether the Managed Databases is encrypted. (default `false`)
*
*/
public Output> encrypted() {
return Codegen.optional(this.encrypted);
}
/**
* The Managed Database engine. (e.g. `postgresql`)
*
*/
@Export(name="engine", refs={String.class}, tree="[0]")
private Output engine;
/**
* @return The Managed Database engine. (e.g. `postgresql`)
*
*/
public Output engine() {
return this.engine;
}
/**
* The Managed Database engine in engine/version format. (e.g. `postgresql/13.2`)
*
*/
@Export(name="engineId", refs={String.class}, tree="[0]")
private Output engineId;
/**
* @return The Managed Database engine in engine/version format. (e.g. `postgresql/13.2`)
*
*/
public Output engineId() {
return this.engineId;
}
/**
* The primary host for the Managed Database.
*
*/
@Export(name="hostPrimary", refs={String.class}, tree="[0]")
private Output hostPrimary;
/**
* @return The primary host for the Managed Database.
*
*/
public Output hostPrimary() {
return this.hostPrimary;
}
/**
* The secondary/private network host for the Managed Database.
*
*/
@Export(name="hostSecondary", refs={String.class}, tree="[0]")
private Output hostSecondary;
/**
* @return The secondary/private network host for the Managed Database.
*
*/
public Output hostSecondary() {
return this.hostSecondary;
}
/**
* A unique, user-defined string referring to the Managed Database.
*
*/
@Export(name="label", refs={String.class}, tree="[0]")
private Output label;
/**
* @return A unique, user-defined string referring to the Managed Database.
*
*/
public Output label() {
return this.label;
}
/**
* The access port for this Managed Database.
*
*/
@Export(name="port", refs={Integer.class}, tree="[0]")
private Output port;
/**
* @return The access port for this Managed Database.
*
*/
public Output port() {
return this.port;
}
/**
* The region to use for the Managed Database.
*
*/
@Export(name="region", refs={String.class}, tree="[0]")
private Output region;
/**
* @return The region to use for the Managed Database.
*
*/
public Output region() {
return this.region;
}
/**
* The synchronization level of the replicating server. (`on`, `local`, `remote_write`, `remote_apply`, `off`; default `off`)
*
* * Must be `local` or `off` for the `asynch` replication type.
*
* * Must be `on`, `remote_write`, or `remote_apply` for the `semi_synch` replication type.
*
*/
@Export(name="replicationCommitType", refs={String.class}, tree="[0]")
private Output replicationCommitType;
/**
* @return The synchronization level of the replicating server. (`on`, `local`, `remote_write`, `remote_apply`, `off`; default `off`)
*
* * Must be `local` or `off` for the `asynch` replication type.
*
* * Must be `on`, `remote_write`, or `remote_apply` for the `semi_synch` replication type.
*
*/
public Output> replicationCommitType() {
return Codegen.optional(this.replicationCommitType);
}
/**
* The replication method used for the Managed Database. (`none`, `asynch`, `semi_synch`; default `none`)
*
* * Must be `none` for a single node cluster.
*
* * Must be `asynch` or `semi_synch` for a high availability cluster.
*
*/
@Export(name="replicationType", refs={String.class}, tree="[0]")
private Output replicationType;
/**
* @return The replication method used for the Managed Database. (`none`, `asynch`, `semi_synch`; default `none`)
*
* * Must be `none` for a single node cluster.
*
* * Must be `asynch` or `semi_synch` for a high availability cluster.
*
*/
public Output> replicationType() {
return Codegen.optional(this.replicationType);
}
/**
* The randomly-generated root password for the Managed Database instance.
*
*/
@Export(name="rootPassword", refs={String.class}, tree="[0]")
private Output rootPassword;
/**
* @return The randomly-generated root password for the Managed Database instance.
*
*/
public Output rootPassword() {
return this.rootPassword;
}
/**
* The root username for the Managed Database instance.
*
*/
@Export(name="rootUsername", refs={String.class}, tree="[0]")
private Output rootUsername;
/**
* @return The root username for the Managed Database instance.
*
*/
public Output rootUsername() {
return this.rootUsername;
}
/**
* Whether to require SSL credentials to establish a connection to the Managed Database. (default `false`)
*
* * `updates` - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
*
*/
@Export(name="sslConnection", refs={Boolean.class}, tree="[0]")
private Output sslConnection;
/**
* @return Whether to require SSL credentials to establish a connection to the Managed Database. (default `false`)
*
* * `updates` - (Optional) Configuration settings for automated patch update maintenance for the Managed Database.
*
*/
public Output> sslConnection() {
return Codegen.optional(this.sslConnection);
}
/**
* The operating status of the Managed Database.
*
*/
@Export(name="status", refs={String.class}, tree="[0]")
private Output status;
/**
* @return The operating status of the Managed Database.
*
*/
public Output status() {
return this.status;
}
/**
* The Linode Instance type used for the nodes of the Managed Database instance.
*
* ***
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The Linode Instance type used for the nodes of the Managed Database instance.
*
* ***
*
*/
public Output type() {
return this.type;
}
/**
* When this Managed Database was last updated.
*
*/
@Export(name="updated", refs={String.class}, tree="[0]")
private Output updated;
/**
* @return When this Managed Database was last updated.
*
*/
public Output updated() {
return this.updated;
}
/**
* Configuration settings for automated patch update maintenance for the Managed Database.
*
*/
@Export(name="updates", refs={DatabasePostgresqlUpdates.class}, tree="[0]")
private Output updates;
/**
* @return Configuration settings for automated patch update maintenance for the Managed Database.
*
*/
public Output updates() {
return this.updates;
}
/**
* The Managed Database engine version. (e.g. `13.2`)
*
*/
@Export(name="version", refs={String.class}, tree="[0]")
private Output version;
/**
* @return The Managed Database engine version. (e.g. `13.2`)
*
*/
public Output version() {
return this.version;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DatabasePostgresql(java.lang.String name) {
this(name, DatabasePostgresqlArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DatabasePostgresql(java.lang.String name, DatabasePostgresqlArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public DatabasePostgresql(java.lang.String name, DatabasePostgresqlArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("linode:index/databasePostgresql:DatabasePostgresql", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private DatabasePostgresql(java.lang.String name, Output id, @Nullable DatabasePostgresqlState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("linode:index/databasePostgresql:DatabasePostgresql", name, state, makeResourceOptions(options, id), false);
}
private static DatabasePostgresqlArgs makeArgs(DatabasePostgresqlArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? DatabasePostgresqlArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"caCert",
"rootPassword",
"rootUsername"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static DatabasePostgresql get(java.lang.String name, Output id, @Nullable DatabasePostgresqlState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DatabasePostgresql(name, id, state, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy