com.hashicorp.cdktf.PgBackend Maven / Gradle / Ivy
package com.hashicorp.cdktf;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.98.0 (build 00b106d)", date = "2024-05-27T11:46:32.225Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = com.hashicorp.cdktf.$Module.class, fqn = "cdktf.PgBackend")
public class PgBackend extends com.hashicorp.cdktf.TerraformBackend {
protected PgBackend(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected PgBackend(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public PgBackend(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.PgBackendConfig props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) Creates a TerraformRemoteState resource that accesses this backend.
*
* @param scope This parameter is required.
* @param name This parameter is required.
* @param _fromStack This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformRemoteState getRemoteStateDataSource(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String name, final @org.jetbrains.annotations.NotNull java.lang.String _fromStack) {
return software.amazon.jsii.Kernel.call(this, "getRemoteStateDataSource", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformRemoteState.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(name, "name is required"), java.util.Objects.requireNonNull(_fromStack, "_fromStack is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
protected @org.jetbrains.annotations.NotNull java.util.Map synthesizeAttributes() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "synthesizeAttributes", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
protected @org.jetbrains.annotations.NotNull java.util.Map synthesizeHclAttributes() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "synthesizeHclAttributes", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
* (experimental) A fluent builder for {@link com.hashicorp.cdktf.PgBackend}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope) {
return new Builder(scope);
}
private final software.constructs.Construct scope;
private final com.hashicorp.cdktf.PgBackendConfig.Builder props;
private Builder(final software.constructs.Construct scope) {
this.scope = scope;
this.props = new com.hashicorp.cdktf.PgBackendConfig.Builder();
}
/**
* (experimental) Postgres connection string;
*
* a postgres:// URL.
* The PG_CONN_STR and standard libpq environment variables can also be used to indicate how to connect to the PostgreSQL database.
*
* @return {@code this}
* @param connStr Postgres connection string;. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder connStr(final java.lang.String connStr) {
this.props.connStr(connStr);
return this;
}
/**
* (experimental) Name of the automatically-managed Postgres schema, default to terraform_remote_state.
*
* Can also be set using the PG_SCHEMA_NAME environment variable.
*
* @return {@code this}
* @param schemaName Name of the automatically-managed Postgres schema, default to terraform_remote_state. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder schemaName(final java.lang.String schemaName) {
this.props.schemaName(schemaName);
return this;
}
/**
* (experimental) If set to true, the Postgres index must already exist.
*
* Can also be set using the PG_SKIP_INDEX_CREATION environment variable.
* Terraform won't try to create the index, this is useful when it has already been created by a database administrator.
*
* @return {@code this}
* @param skipIndexCreation If set to true, the Postgres index must already exist. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder skipIndexCreation(final java.lang.Boolean skipIndexCreation) {
this.props.skipIndexCreation(skipIndexCreation);
return this;
}
/**
* (experimental) If set to true, the Postgres schema must already exist.
*
* Can also be set using the PG_SKIP_SCHEMA_CREATION environment variable.
* Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.
*
* @return {@code this}
* @param skipSchemaCreation If set to true, the Postgres schema must already exist. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder skipSchemaCreation(final java.lang.Boolean skipSchemaCreation) {
this.props.skipSchemaCreation(skipSchemaCreation);
return this;
}
/**
* (experimental) If set to true, the Postgres table must already exist.
*
* Can also be set using the PG_SKIP_TABLE_CREATION environment variable.
* Terraform won't try to create the table, this is useful when it has already been created by a database administrator.
*
* @return {@code this}
* @param skipTableCreation If set to true, the Postgres table must already exist. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder skipTableCreation(final java.lang.Boolean skipTableCreation) {
this.props.skipTableCreation(skipTableCreation);
return this;
}
/**
* @return a newly built instance of {@link com.hashicorp.cdktf.PgBackend}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public com.hashicorp.cdktf.PgBackend build() {
return new com.hashicorp.cdktf.PgBackend(
this.scope,
this.props.build()
);
}
}
}