Skip to content

provider.java.md

Latest commit

 

History

History
819 lines (506 loc) · 34.6 KB

provider.java.md

File metadata and controls

819 lines (506 loc) · 34.6 KB

provider Submodule

Constructs

CloudflareProvider

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs cloudflare}.

Initializers 

import io.cdktn.providers.cloudflare.provider.CloudflareProvider;

CloudflareProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .apiKey(java.lang.String)
//  .apiToken(java.lang.String)
//  .apiUserServiceKey(java.lang.String)
//  .baseUrl(java.lang.String)
//  .email(java.lang.String)
//  .userAgentOperatorSuffix(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.
alias java.lang.String Alias name.
apiKey java.lang.String The API key for operations.
apiToken java.lang.String The API Token for operations.
apiUserServiceKey java.lang.String A special Cloudflare API key good for a restricted set of endpoints.
baseUrl java.lang.String Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.
email java.lang.String A registered Cloudflare email address.
userAgentOperatorSuffix java.lang.String A value to append to the HTTP User Agent for all API calls.
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

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#alias CloudflareProvider#alias}

apiKeyOptional
  • Type: java.lang.String

The API key for operations.

Alternatively, can be configured using the CLOUDFLARE_API_KEY environment variable. API keys are now considered legacy by Cloudflare, API tokens should be used instead. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_key CloudflareProvider#api_key}

apiTokenOptional
  • Type: java.lang.String

The API Token for operations.

Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_token CloudflareProvider#api_token}

apiUserServiceKeyOptional
  • Type: java.lang.String

A special Cloudflare API key good for a restricted set of endpoints.

Alternatively, can be configured using the CLOUDFLARE_API_USER_SERVICE_KEY environment variable. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_user_service_key CloudflareProvider#api_user_service_key}

baseUrlOptional
  • Type: java.lang.String

Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#base_url CloudflareProvider#base_url}

emailOptional
  • Type: java.lang.String

A registered Cloudflare email address.

Alternatively, can be configured using the CLOUDFLARE_EMAIL environment variable. Required when using api_key. Conflicts with api_token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#email CloudflareProvider#email}

userAgentOperatorSuffixOptional
  • Type: java.lang.String

A value to append to the HTTP User Agent for all API calls.

This value is not something most users need to modify however, if you are using a non-standard provider or operator configuration, this is recommended to assist in uniquely identifying your traffic. Setting this value will remove the Terraform version from the HTTP User Agent string and may have unintended consequences. Alternatively, can be configured using the CLOUDFLARE_USER_AGENT_OPERATOR_SUFFIX environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#user_agent_operator_suffix CloudflareProvider#user_agent_operator_suffix}

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to 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.
resetAlias No description.
resetApiKey No description.
resetApiToken No description.
resetApiUserServiceKey No description.
resetBaseUrl No description.
resetEmail No description.
resetUserAgentOperatorSuffix No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

with 
public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: software.constructs.IMixin...

The mixins to apply.

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.

resetAlias 
public void resetAlias()
resetApiKey 
public void resetApiKey()
resetApiToken 
public void resetApiToken()
resetApiUserServiceKey 
public void resetApiUserServiceKey()
resetBaseUrl 
public void resetBaseUrl()
resetEmail 
public void resetEmail()
resetUserAgentOperatorSuffix 
public void resetUserAgentOperatorSuffix()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTN code for importing a CloudflareProvider resource upon running "cdktn plan ".
isConstruct 
import io.cdktn.providers.cloudflare.provider.CloudflareProvider;

CloudflareProvider.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 io.cdktn.providers.cloudflare.provider.CloudflareProvider;

CloudflareProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import io.cdktn.providers.cloudflare.provider.CloudflareProvider;

CloudflareProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import io.cdktn.providers.cloudflare.provider.CloudflareProvider;

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

Generates CDKTN code for importing a CloudflareProvider resource upon running "cdktn 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 CloudflareProvider to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing CloudflareProvider that should be imported.

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

providerOptional
  • Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack io.cdktn.cdktn.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata io.cdktn.cdktn.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
aliasInput java.lang.String No description.
apiKeyInput java.lang.String No description.
apiTokenInput java.lang.String No description.
apiUserServiceKeyInput java.lang.String No description.
baseUrlInput java.lang.String No description.
emailInput java.lang.String No description.
userAgentOperatorSuffixInput java.lang.String No description.
apiKey java.lang.String No description.
apiToken java.lang.String No description.
apiUserServiceKey java.lang.String No description.
baseUrl java.lang.String No description.
email java.lang.String No description.
userAgentOperatorSuffix java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: io.cdktn.cdktn.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • 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: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
apiKeyInputOptional 
public java.lang.String getApiKeyInput();
  • Type: java.lang.String
apiTokenInputOptional 
public java.lang.String getApiTokenInput();
  • Type: java.lang.String
apiUserServiceKeyInputOptional 
public java.lang.String getApiUserServiceKeyInput();
  • Type: java.lang.String
baseUrlInputOptional 
public java.lang.String getBaseUrlInput();
  • Type: java.lang.String
emailInputOptional 
public java.lang.String getEmailInput();
  • Type: java.lang.String
userAgentOperatorSuffixInputOptional 
public java.lang.String getUserAgentOperatorSuffixInput();
  • Type: java.lang.String
apiKeyOptional 
public java.lang.String getApiKey();
  • Type: java.lang.String
apiTokenOptional 
public java.lang.String getApiToken();
  • Type: java.lang.String
apiUserServiceKeyOptional 
public java.lang.String getApiUserServiceKey();
  • Type: java.lang.String
baseUrlOptional 
public java.lang.String getBaseUrl();
  • Type: java.lang.String
emailOptional 
public java.lang.String getEmail();
  • Type: java.lang.String
userAgentOperatorSuffixOptional 
public java.lang.String getUserAgentOperatorSuffix();
  • 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

CloudflareProviderConfig

Initializer 

import io.cdktn.providers.cloudflare.provider.CloudflareProviderConfig;

CloudflareProviderConfig.builder()
//  .alias(java.lang.String)
//  .apiKey(java.lang.String)
//  .apiToken(java.lang.String)
//  .apiUserServiceKey(java.lang.String)
//  .baseUrl(java.lang.String)
//  .email(java.lang.String)
//  .userAgentOperatorSuffix(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
apiKey java.lang.String The API key for operations.
apiToken java.lang.String The API Token for operations.
apiUserServiceKey java.lang.String A special Cloudflare API key good for a restricted set of endpoints.
baseUrl java.lang.String Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.
email java.lang.String A registered Cloudflare email address.
userAgentOperatorSuffix java.lang.String A value to append to the HTTP User Agent for all API calls.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#alias CloudflareProvider#alias}

apiKeyOptional 
public java.lang.String getApiKey();
  • Type: java.lang.String

The API key for operations.

Alternatively, can be configured using the CLOUDFLARE_API_KEY environment variable. API keys are now considered legacy by Cloudflare, API tokens should be used instead. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_key CloudflareProvider#api_key}

apiTokenOptional 
public java.lang.String getApiToken();
  • Type: java.lang.String

The API Token for operations.

Alternatively, can be configured using the CLOUDFLARE_API_TOKEN environment variable. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_token CloudflareProvider#api_token}

apiUserServiceKeyOptional 
public java.lang.String getApiUserServiceKey();
  • Type: java.lang.String

A special Cloudflare API key good for a restricted set of endpoints.

Alternatively, can be configured using the CLOUDFLARE_API_USER_SERVICE_KEY environment variable. Must provide only one of api_key, api_token, api_user_service_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#api_user_service_key CloudflareProvider#api_user_service_key}

baseUrlOptional 
public java.lang.String getBaseUrl();
  • Type: java.lang.String

Value to override the default HTTP client base URL. Alternatively, can be configured using the base_url environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#base_url CloudflareProvider#base_url}

emailOptional 
public java.lang.String getEmail();
  • Type: java.lang.String

A registered Cloudflare email address.

Alternatively, can be configured using the CLOUDFLARE_EMAIL environment variable. Required when using api_key. Conflicts with api_token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#email CloudflareProvider#email}

userAgentOperatorSuffixOptional 
public java.lang.String getUserAgentOperatorSuffix();
  • Type: java.lang.String

A value to append to the HTTP User Agent for all API calls.

This value is not something most users need to modify however, if you are using a non-standard provider or operator configuration, this is recommended to assist in uniquely identifying your traffic. Setting this value will remove the Terraform version from the HTTP User Agent string and may have unintended consequences. Alternatively, can be configured using the CLOUDFLARE_USER_AGENT_OPERATOR_SUFFIX environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.19.1/docs#user_agent_operator_suffix CloudflareProvider#user_agent_operator_suffix}