Skip to content

Latest commit

 

History

History
2120 lines (1319 loc) · 96.8 KB

hyperdriveConfig.java.md

File metadata and controls

2120 lines (1319 loc) · 96.8 KB

hyperdriveConfig Submodule

Constructs

HyperdriveConfig

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config cloudflare_hyperdrive_config}.

Initializers

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfig;

HyperdriveConfig.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .accountId(java.lang.String)
    .name(java.lang.String)
    .origin(HyperdriveConfigOrigin)
//  .caching(HyperdriveConfigCaching)
//  .id(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accountId java.lang.String The account identifier to target for the resource.
name java.lang.String The name of the Hyperdrive configuration.
origin HyperdriveConfigOrigin The origin details for the Hyperdrive configuration.
caching HyperdriveConfigCaching The caching details for the Hyperdrive configuration.
id java.lang.String The identifier of this resource. This is the hyperdrive config value.

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

accountIdRequired
  • Type: java.lang.String

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#account_id HyperdriveConfig#account_id}


nameRequired
  • Type: java.lang.String

The name of the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#name HyperdriveConfig#name}


originRequired

The origin details for the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#origin HyperdriveConfig#origin}


cachingOptional

The caching details for the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#caching HyperdriveConfig#caching}


idOptional
  • Type: java.lang.String

The identifier of this resource. This is the hyperdrive config value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#id HyperdriveConfig#id}

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putCaching No description.
putOrigin No description.
resetCaching No description.
resetId No description.

toString
public java.lang.String toString()

Returns a string representation of this construct.

addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String

valueRequired
  • Type: java.lang.Object

overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.


resetOverrideLogicalId
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public java.lang.Object toHclTerraform()
toMetadata
public java.lang.Object toMetadata()
toTerraform
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.


getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

hasResourceMove
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

moveFromId
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putCaching
public void putCaching(HyperdriveConfigCaching value)
valueRequired

putOrigin
public void putOrigin(HyperdriveConfigOrigin value)
valueRequired

resetCaching
public void resetCaching()
resetId
public void resetId()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a HyperdriveConfig resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfig;

HyperdriveConfig.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfig;

HyperdriveConfig.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformResource
import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfig;

HyperdriveConfig.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfig;

HyperdriveConfig.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),HyperdriveConfig.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a HyperdriveConfig resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the HyperdriveConfig to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing HyperdriveConfig that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the HyperdriveConfig to import is found.


Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
caching HyperdriveConfigCachingOutputReference No description.
origin HyperdriveConfigOriginOutputReference No description.
accountIdInput java.lang.String No description.
cachingInput com.hashicorp.cdktf.IResolvable OR HyperdriveConfigCaching No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
originInput com.hashicorp.cdktf.IResolvable OR HyperdriveConfigOrigin No description.
accountId java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.

nodeRequired
public Node getNode();
  • Type: software.constructs.Node

The tree node.


cdktfStackRequired
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack

fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

terraformMetaArgumentsRequired
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>

terraformResourceTypeRequired
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String

terraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

cachingRequired
public HyperdriveConfigCachingOutputReference getCaching();

originRequired
public HyperdriveConfigOriginOutputReference getOrigin();

accountIdInputOptional
public java.lang.String getAccountIdInput();
  • Type: java.lang.String

cachingInputOptional
public java.lang.Object getCachingInput();

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

originInputOptional
public java.lang.Object getOriginInput();

accountIdRequired
public java.lang.String getAccountId();
  • Type: java.lang.String

idRequired
public java.lang.String getId();
  • Type: java.lang.String

nameRequired
public java.lang.String getName();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

HyperdriveConfigCaching

Initializer

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfigCaching;

HyperdriveConfigCaching.builder()
//  .disabled(java.lang.Boolean)
//  .disabled(IResolvable)
//  .maxAge(java.lang.Number)
//  .staleWhileRevalidate(java.lang.Number)
    .build();

Properties

Name Type Description
disabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disable caching for this Hyperdrive configuration.
maxAge java.lang.Number Configure the max_age value of this Hyperdrive configuration.
staleWhileRevalidate java.lang.Number Disable caching for this Hyperdrive configuration.

disabledOptional
public java.lang.Object getDisabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disable caching for this Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#disabled HyperdriveConfig#disabled}


maxAgeOptional
public java.lang.Number getMaxAge();
  • Type: java.lang.Number

Configure the max_age value of this Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#max_age HyperdriveConfig#max_age}


staleWhileRevalidateOptional
public java.lang.Number getStaleWhileRevalidate();
  • Type: java.lang.Number

Disable caching for this Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#stale_while_revalidate HyperdriveConfig#stale_while_revalidate}


HyperdriveConfigConfig

Initializer

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfigConfig;

HyperdriveConfigConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .accountId(java.lang.String)
    .name(java.lang.String)
    .origin(HyperdriveConfigOrigin)
//  .caching(HyperdriveConfigCaching)
//  .id(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accountId java.lang.String The account identifier to target for the resource.
name java.lang.String The name of the Hyperdrive configuration.
origin HyperdriveConfigOrigin The origin details for the Hyperdrive configuration.
caching HyperdriveConfigCaching The caching details for the Hyperdrive configuration.
id java.lang.String The identifier of this resource. This is the hyperdrive config value.

connectionOptional
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection

countOptional
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount

dependsOnOptional
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

forEachOptional
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator

lifecycleOptional
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle

providerOptional
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider

provisionersOptional
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

accountIdRequired
public java.lang.String getAccountId();
  • Type: java.lang.String

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#account_id HyperdriveConfig#account_id}


nameRequired
public java.lang.String getName();
  • Type: java.lang.String

The name of the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#name HyperdriveConfig#name}


originRequired
public HyperdriveConfigOrigin getOrigin();

The origin details for the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#origin HyperdriveConfig#origin}


cachingOptional
public HyperdriveConfigCaching getCaching();

The caching details for the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#caching HyperdriveConfig#caching}


idOptional
public java.lang.String getId();
  • Type: java.lang.String

The identifier of this resource. This is the hyperdrive config value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#id HyperdriveConfig#id}

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


HyperdriveConfigOrigin

Initializer

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfigOrigin;

HyperdriveConfigOrigin.builder()
    .database(java.lang.String)
    .host(java.lang.String)
    .password(java.lang.String)
    .scheme(java.lang.String)
    .user(java.lang.String)
//  .accessClientId(java.lang.String)
//  .accessClientSecret(java.lang.String)
//  .port(java.lang.Number)
    .build();

Properties

Name Type Description
database java.lang.String The name of your origin database.
host java.lang.String The host (hostname or IP) of your origin database.
password java.lang.String The password of the Hyperdrive configuration.
scheme java.lang.String Specifies the URL scheme used to connect to your origin database.
user java.lang.String The user of your origin database.
accessClientId java.lang.String Client ID associated with the Cloudflare Access Service Token used to connect via Access.
accessClientSecret java.lang.String Client Secret associated with the Cloudflare Access Service Token used to connect via Access.
port java.lang.Number The port (default: 5432 for Postgres) of your origin database.

databaseRequired
public java.lang.String getDatabase();
  • Type: java.lang.String

The name of your origin database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#database HyperdriveConfig#database}


hostRequired
public java.lang.String getHost();
  • Type: java.lang.String

The host (hostname or IP) of your origin database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#host HyperdriveConfig#host}


passwordRequired
public java.lang.String getPassword();
  • Type: java.lang.String

The password of the Hyperdrive configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#password HyperdriveConfig#password}


schemeRequired
public java.lang.String getScheme();
  • Type: java.lang.String

Specifies the URL scheme used to connect to your origin database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#scheme HyperdriveConfig#scheme}


userRequired
public java.lang.String getUser();
  • Type: java.lang.String

The user of your origin database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#user HyperdriveConfig#user}


accessClientIdOptional
public java.lang.String getAccessClientId();
  • Type: java.lang.String

Client ID associated with the Cloudflare Access Service Token used to connect via Access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#access_client_id HyperdriveConfig#access_client_id}


accessClientSecretOptional
public java.lang.String getAccessClientSecret();
  • Type: java.lang.String

Client Secret associated with the Cloudflare Access Service Token used to connect via Access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#access_client_secret HyperdriveConfig#access_client_secret}


portOptional
public java.lang.Number getPort();
  • Type: java.lang.Number

The port (default: 5432 for Postgres) of your origin database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.45.0/docs/resources/hyperdrive_config#port HyperdriveConfig#port}


Classes

HyperdriveConfigCachingOutputReference

Initializers

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfigCachingOutputReference;

new HyperdriveConfigCachingOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDisabled No description.
resetMaxAge No description.
resetStaleWhileRevalidate No description.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDisabled
public void resetDisabled()
resetMaxAge
public void resetMaxAge()
resetStaleWhileRevalidate
public void resetStaleWhileRevalidate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
disabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxAgeInput java.lang.Number No description.
staleWhileRevalidateInput java.lang.Number No description.
disabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxAge java.lang.Number No description.
staleWhileRevalidate java.lang.Number No description.
internalValue com.hashicorp.cdktf.IResolvable OR HyperdriveConfigCaching No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

disabledInputOptional
public java.lang.Object getDisabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

maxAgeInputOptional
public java.lang.Number getMaxAgeInput();
  • Type: java.lang.Number

staleWhileRevalidateInputOptional
public java.lang.Number getStaleWhileRevalidateInput();
  • Type: java.lang.Number

disabledRequired
public java.lang.Object getDisabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

maxAgeRequired
public java.lang.Number getMaxAge();
  • Type: java.lang.Number

staleWhileRevalidateRequired
public java.lang.Number getStaleWhileRevalidate();
  • Type: java.lang.Number

internalValueOptional
public java.lang.Object getInternalValue();

HyperdriveConfigOriginOutputReference

Initializers

import com.hashicorp.cdktf.providers.cloudflare.hyperdrive_config.HyperdriveConfigOriginOutputReference;

new HyperdriveConfigOriginOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAccessClientId No description.
resetAccessClientSecret No description.
resetPort No description.

computeFqn
public java.lang.String computeFqn()
getAnyMapAttribute
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanAttribute
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getBooleanMapAttribute
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getListAttribute
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberAttribute
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberListAttribute
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getNumberMapAttribute
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringAttribute
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

getStringMapAttribute
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String

resolve
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext

toString
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAccessClientId
public void resetAccessClientId()
resetAccessClientSecret
public void resetAccessClientSecret()
resetPort
public void resetPort()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
accessClientIdInput java.lang.String No description.
accessClientSecretInput java.lang.String No description.
databaseInput java.lang.String No description.
hostInput java.lang.String No description.
passwordInput java.lang.String No description.
portInput java.lang.Number No description.
schemeInput java.lang.String No description.
userInput java.lang.String No description.
accessClientId java.lang.String No description.
accessClientSecret java.lang.String No description.
database java.lang.String No description.
host java.lang.String No description.
password java.lang.String No description.
port java.lang.Number No description.
scheme java.lang.String No description.
user java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR HyperdriveConfigOrigin No description.

creationStackRequired
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public java.lang.String getFqn();
  • Type: java.lang.String

accessClientIdInputOptional
public java.lang.String getAccessClientIdInput();
  • Type: java.lang.String

accessClientSecretInputOptional
public java.lang.String getAccessClientSecretInput();
  • Type: java.lang.String

databaseInputOptional
public java.lang.String getDatabaseInput();
  • Type: java.lang.String

hostInputOptional
public java.lang.String getHostInput();
  • Type: java.lang.String

passwordInputOptional
public java.lang.String getPasswordInput();
  • Type: java.lang.String

portInputOptional
public java.lang.Number getPortInput();
  • Type: java.lang.Number

schemeInputOptional
public java.lang.String getSchemeInput();
  • Type: java.lang.String

userInputOptional
public java.lang.String getUserInput();
  • Type: java.lang.String

accessClientIdRequired
public java.lang.String getAccessClientId();
  • Type: java.lang.String

accessClientSecretRequired
public java.lang.String getAccessClientSecret();
  • Type: java.lang.String

databaseRequired
public java.lang.String getDatabase();
  • Type: java.lang.String

hostRequired
public java.lang.String getHost();
  • Type: java.lang.String

passwordRequired
public java.lang.String getPassword();
  • Type: java.lang.String

portRequired
public java.lang.Number getPort();
  • Type: java.lang.Number

schemeRequired
public java.lang.String getScheme();
  • Type: java.lang.String

userRequired
public java.lang.String getUser();
  • Type: java.lang.String

internalValueOptional
public java.lang.Object getInternalValue();