com.hashicorp.cdktf.DataTerraformRemoteStateConsul Maven / Gradle / Ivy
package com.hashicorp.cdktf;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.98.0 (build 00b106d)", date = "2024-05-27T11:46:32.072Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = com.hashicorp.cdktf.$Module.class, fqn = "cdktf.DataTerraformRemoteStateConsul")
public class DataTerraformRemoteStateConsul extends com.hashicorp.cdktf.TerraformRemoteState {
protected DataTerraformRemoteStateConsul(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected DataTerraformRemoteStateConsul(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param config This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public DataTerraformRemoteStateConsul(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.DataTerraformRemoteStateConsulConfig config) {
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(id, "id is required"), java.util.Objects.requireNonNull(config, "config is required") });
}
/**
* (experimental) A fluent builder for {@link com.hashicorp.cdktf.DataTerraformRemoteStateConsul}.
*/
@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.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final com.hashicorp.cdktf.DataTerraformRemoteStateConsulConfig.Builder config;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.config = new com.hashicorp.cdktf.DataTerraformRemoteStateConsulConfig.Builder();
}
/**
* @return {@code this}
* @param defaults This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder defaults(final java.util.Map defaults) {
this.config.defaults(defaults);
return this;
}
/**
* @return {@code this}
* @param workspace This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder workspace(final java.lang.String workspace) {
this.config.workspace(workspace);
return this;
}
/**
* (experimental) (Required) Access token.
*
* @return {@code this}
* @param accessToken (Required) Access token. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder accessToken(final java.lang.String accessToken) {
this.config.accessToken(accessToken);
return this;
}
/**
* (experimental) (Required) Path in the Consul KV store.
*
* @return {@code this}
* @param path (Required) Path in the Consul KV store. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder path(final java.lang.String path) {
this.config.path(path);
return this;
}
/**
* (experimental) (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
*
* Defaults to the local agent HTTP listener.
*
* @return {@code this}
* @param address (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder address(final java.lang.String address) {
this.config.address(address);
return this;
}
/**
* (experimental) (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
*
* @return {@code this}
* @param caFile (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder caFile(final java.lang.String caFile) {
this.config.caFile(caFile);
return this;
}
/**
* (experimental) (Optional) A path to a PEM-encoded certificate provided to the remote agent;
*
* requires use of key_file.
*
* @return {@code this}
* @param certFile (Optional) A path to a PEM-encoded certificate provided to the remote agent;. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder certFile(final java.lang.String certFile) {
this.config.certFile(certFile);
return this;
}
/**
* (experimental) (Optional) The datacenter to use.
*
* Defaults to that of the agent.
*
* @return {@code this}
* @param datacenter (Optional) The datacenter to use. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder datacenter(final java.lang.String datacenter) {
this.config.datacenter(datacenter);
return this;
}
/**
* (experimental) (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
*
* @return {@code this}
* @param gzip (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder gzip(final java.lang.Boolean gzip) {
this.config.gzip(gzip);
return this;
}
/**
* (experimental) (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
*
* @return {@code this}
* @param httpAuth (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder httpAuth(final java.lang.String httpAuth) {
this.config.httpAuth(httpAuth);
return this;
}
/**
* (experimental) (Optional) A path to a PEM-encoded private key, required if cert_file is specified.
*
* @return {@code this}
* @param keyFile (Optional) A path to a PEM-encoded private key, required if cert_file is specified. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder keyFile(final java.lang.String keyFile) {
this.config.keyFile(keyFile);
return this;
}
/**
* (experimental) (Optional) false to disable locking.
*
* This defaults to true, but will require session permissions with Consul and
* at least kv write permissions on $path/.lock to perform locking.
*
* @return {@code this}
* @param lock (Optional) false to disable locking. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder lock(final java.lang.Boolean lock) {
this.config.lock(lock);
return this;
}
/**
* (experimental) (Optional) Specifies what protocol to use when talking to the given address,either http or https.
*
* SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.
*
* @return {@code this}
* @param scheme (Optional) Specifies what protocol to use when talking to the given address,either http or https. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder scheme(final java.lang.String scheme) {
this.config.scheme(scheme);
return this;
}
/**
* @return a newly built instance of {@link com.hashicorp.cdktf.DataTerraformRemoteStateConsul}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public com.hashicorp.cdktf.DataTerraformRemoteStateConsul build() {
return new com.hashicorp.cdktf.DataTerraformRemoteStateConsul(
this.scope,
this.id,
this.config.build()
);
}
}
}