Documentation
¶
Index ¶
- func CloudflareProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func CloudflareProvider_IsConstruct(x interface{}) *bool
- func CloudflareProvider_IsTerraformElement(x interface{}) *bool
- func CloudflareProvider_IsTerraformProvider(x interface{}) *bool
- func CloudflareProvider_TfResourceType() *string
- func NewCloudflareProvider_Override(c CloudflareProvider, scope constructs.Construct, id *string, ...)
- type CloudflareProvider
- type CloudflareProviderConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloudflareProvider_GenerateConfigForImport ¶
func CloudflareProvider_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a CloudflareProvider resource upon running "cdktf plan <stack-name>".
func CloudflareProvider_IsConstruct ¶
func CloudflareProvider_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CloudflareProvider_IsTerraformElement ¶
func CloudflareProvider_IsTerraformElement(x interface{}) *bool
Experimental.
func CloudflareProvider_IsTerraformProvider ¶
func CloudflareProvider_IsTerraformProvider(x interface{}) *bool
Experimental.
func CloudflareProvider_TfResourceType ¶
func CloudflareProvider_TfResourceType() *string
func NewCloudflareProvider_Override ¶
func NewCloudflareProvider_Override(c CloudflareProvider, scope constructs.Construct, id *string, config *CloudflareProviderConfig)
Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.7.1/docs cloudflare} Resource.
Types ¶
type CloudflareProvider ¶
type CloudflareProvider interface {
cdktf.TerraformProvider
Alias() *string
SetAlias(val *string)
AliasInput() *string
ApiKey() *string
SetApiKey(val *string)
ApiKeyInput() *string
ApiToken() *string
SetApiToken(val *string)
ApiTokenInput() *string
ApiUserServiceKey() *string
SetApiUserServiceKey(val *string)
ApiUserServiceKeyInput() *string
BaseUrl() *string
SetBaseUrl(val *string)
BaseUrlInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
Email() *string
SetEmail(val *string)
EmailInput() *string
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
// Experimental.
MetaAttributes() *map[string]interface{}
// The tree node.
Node() constructs.Node
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformProviderSource() *string
// Experimental.
TerraformResourceType() *string
UserAgentOperatorSuffix() *string
SetUserAgentOperatorSuffix(val *string)
UserAgentOperatorSuffixInput() *string
// Experimental.
AddOverride(path *string, value interface{})
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAlias()
ResetApiKey()
ResetApiToken()
ResetApiUserServiceKey()
ResetBaseUrl()
ResetEmail()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetUserAgentOperatorSuffix()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.7.1/docs cloudflare}.
func NewCloudflareProvider ¶
func NewCloudflareProvider(scope constructs.Construct, id *string, config *CloudflareProviderConfig) CloudflareProvider
Create a new {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.7.1/docs cloudflare} Resource.
type CloudflareProviderConfig ¶
type CloudflareProviderConfig struct {
// Alias name.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.7.1/docs#alias CloudflareProvider#alias}
Alias *string `field:"optional" json:"alias" yaml:"alias"`
// The API key for operations.
//
// Alternatively, can be configured using the `CLOUDFLARE_API_KEY` environment variable. API keys are [now considered legacy by Cloudflare](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations), 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.7.1/docs#api_key CloudflareProvider#api_key}
ApiKey *string `field:"optional" json:"apiKey" yaml:"apiKey"`
// 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.7.1/docs#api_token CloudflareProvider#api_token}
ApiToken *string `field:"optional" json:"apiToken" yaml:"apiToken"`
// 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.7.1/docs#api_user_service_key CloudflareProvider#api_user_service_key}
ApiUserServiceKey *string `field:"optional" json:"apiUserServiceKey" yaml:"apiUserServiceKey"`
// 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.7.1/docs#base_url CloudflareProvider#base_url}
BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
// 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.7.1/docs#email CloudflareProvider#email}
Email *string `field:"optional" json:"email" yaml:"email"`
// 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.7.1/docs#user_agent_operator_suffix CloudflareProvider#user_agent_operator_suffix}
UserAgentOperatorSuffix *string `field:"optional" json:"userAgentOperatorSuffix" yaml:"userAgentOperatorSuffix"`
}