Skip to content

Latest commit

 

History

History
1483 lines (927 loc) · 54.6 KB

dataHttp.go.md

File metadata and controls

1483 lines (927 loc) · 54.6 KB

dataHttp Submodule

Constructs

DataHttp

Represents a {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http http}.

Initializers

import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.NewDataHttp(scope Construct, id *string, config DataHttpConfig) DataHttp
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DataHttpConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
PutRetry No description.
ResetCaCertPem No description.
ResetInsecure No description.
ResetMethod No description.
ResetRequestBody No description.
ResetRequestHeaders No description.
ResetRequestTimeoutMs No description.
ResetRetry No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

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

ToHclTerraform
func ToHclTerraform() interface{}

Adds this resource to the terraform JSON output.

ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

PutRetry
func PutRetry(value DataHttpRetry)
valueRequired

ResetCaCertPem
func ResetCaCertPem()
ResetInsecure
func ResetInsecure()
ResetMethod
func ResetMethod()
ResetRequestBody
func ResetRequestBody()
ResetRequestHeaders
func ResetRequestHeaders()
ResetRequestTimeoutMs
func ResetRequestTimeoutMs()
ResetRetry
func ResetRetry()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataHttp resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.DataHttp_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.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.DataHttp_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformDataSource
import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.DataHttp_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.DataHttp_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

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


importFromIdRequired
  • Type: *string

The id of the existing DataHttp that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Body *string No description.
Id *string No description.
ResponseBody *string No description.
ResponseBodyBase64 *string No description.
ResponseHeaders github.com/hashicorp/terraform-cdk-go/cdktf.StringMap No description.
Retry DataHttpRetryOutputReference No description.
StatusCode *f64 No description.
CaCertPemInput *string No description.
InsecureInput interface{} No description.
MethodInput *string No description.
RequestBodyInput *string No description.
RequestHeadersInput *map[string]*string No description.
RequestTimeoutMsInput *f64 No description.
RetryInput interface{} No description.
UrlInput *string No description.
CaCertPem *string No description.
Insecure interface{} No description.
Method *string No description.
RequestBody *string No description.
RequestHeaders *map[string]*string No description.
RequestTimeoutMs *f64 No description.
Url *string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

BodyRequired
func Body() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

ResponseBodyRequired
func ResponseBody() *string
  • Type: *string

ResponseBodyBase64Required
func ResponseBodyBase64() *string
  • Type: *string

ResponseHeadersRequired
func ResponseHeaders() StringMap
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.StringMap

RetryRequired
func Retry() DataHttpRetryOutputReference

StatusCodeRequired
func StatusCode() *f64
  • Type: *f64

CaCertPemInputOptional
func CaCertPemInput() *string
  • Type: *string

InsecureInputOptional
func InsecureInput() interface{}
  • Type: interface{}

MethodInputOptional
func MethodInput() *string
  • Type: *string

RequestBodyInputOptional
func RequestBodyInput() *string
  • Type: *string

RequestHeadersInputOptional
func RequestHeadersInput() *map[string]*string
  • Type: *map[string]*string

RequestTimeoutMsInputOptional
func RequestTimeoutMsInput() *f64
  • Type: *f64

RetryInputOptional
func RetryInput() interface{}
  • Type: interface{}

UrlInputOptional
func UrlInput() *string
  • Type: *string

CaCertPemRequired
func CaCertPem() *string
  • Type: *string

InsecureRequired
func Insecure() interface{}
  • Type: interface{}

MethodRequired
func Method() *string
  • Type: *string

RequestBodyRequired
func RequestBody() *string
  • Type: *string

RequestHeadersRequired
func RequestHeaders() *map[string]*string
  • Type: *map[string]*string

RequestTimeoutMsRequired
func RequestTimeoutMs() *f64
  • Type: *f64

UrlRequired
func Url() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

DataHttpConfig

Initializer

import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

&datahttp.DataHttpConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Url: *string,
	CaCertPem: *string,
	Insecure: interface{},
	Method: *string,
	RequestBody: *string,
	RequestHeaders: *map[string]*string,
	RequestTimeoutMs: *f64,
	Retry: github.com/cdktf/cdktf-provider-http-go/http/v9.dataHttp.DataHttpRetry,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Url *string The URL for the request. Supported schemes are http and https.
CaCertPem *string Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.
Insecure interface{} Disables verification of the server's certificate chain and hostname. Defaults to false.
Method *string The HTTP Method for the request.
RequestBody *string The request body as a string.
RequestHeaders *map[string]*string A map of request header field names and values.
RequestTimeoutMs *f64 The request timeout in milliseconds.
Retry DataHttpRetry retry block.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

UrlRequired
Url *string
  • Type: *string

The URL for the request. Supported schemes are http and https.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#url DataHttp#url}


CaCertPemOptional
CaCertPem *string
  • Type: *string

Certificate data of the Certificate Authority (CA) in PEM (RFC 1421) format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#ca_cert_pem DataHttp#ca_cert_pem}


InsecureOptional
Insecure interface{}
  • Type: interface{}

Disables verification of the server's certificate chain and hostname. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#insecure DataHttp#insecure}


MethodOptional
Method *string
  • Type: *string

The HTTP Method for the request.

Allowed methods are a subset of methods defined in RFC7231 namely, GET, HEAD, and POST. POST support is only intended for read-only URLs, such as submitting a search.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#method DataHttp#method}


RequestBodyOptional
RequestBody *string
  • Type: *string

The request body as a string.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#request_body DataHttp#request_body}


RequestHeadersOptional
RequestHeaders *map[string]*string
  • Type: *map[string]*string

A map of request header field names and values.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#request_headers DataHttp#request_headers}


RequestTimeoutMsOptional
RequestTimeoutMs *f64
  • Type: *f64

The request timeout in milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#request_timeout_ms DataHttp#request_timeout_ms}


RetryOptional
Retry DataHttpRetry

retry block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#retry DataHttp#retry}


DataHttpRetry

Initializer

import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

&datahttp.DataHttpRetry {
	Attempts: *f64,
	MaxDelayMs: *f64,
	MinDelayMs: *f64,
}

Properties

Name Type Description
Attempts *f64 The number of times the request is to be retried.
MaxDelayMs *f64 The maximum delay between retry requests in milliseconds.
MinDelayMs *f64 The minimum delay between retry requests in milliseconds.

AttemptsOptional
Attempts *f64
  • Type: *f64

The number of times the request is to be retried.

For example, if 2 is specified, the request will be tried a maximum of 3 times.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#attempts DataHttp#attempts}


MaxDelayMsOptional
MaxDelayMs *f64
  • Type: *f64

The maximum delay between retry requests in milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#max_delay_ms DataHttp#max_delay_ms}


MinDelayMsOptional
MinDelayMs *f64
  • Type: *f64

The minimum delay between retry requests in milliseconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/http/3.4.3/docs/data-sources/http#min_delay_ms DataHttp#min_delay_ms}


Classes

DataHttpRetryOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-http-go/http/v9/datahttp"

datahttp.NewDataHttpRetryOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DataHttpRetryOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *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.
ResetAttempts No description.
ResetMaxDelayMs No description.
ResetMinDelayMs No description.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetAttempts
func ResetAttempts()
ResetMaxDelayMs
func ResetMaxDelayMs()
ResetMinDelayMs
func ResetMinDelayMs()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
AttemptsInput *f64 No description.
MaxDelayMsInput *f64 No description.
MinDelayMsInput *f64 No description.
Attempts *f64 No description.
MaxDelayMs *f64 No description.
MinDelayMs *f64 No description.
InternalValue interface{} No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*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
func Fqn() *string
  • Type: *string

AttemptsInputOptional
func AttemptsInput() *f64
  • Type: *f64

MaxDelayMsInputOptional
func MaxDelayMsInput() *f64
  • Type: *f64

MinDelayMsInputOptional
func MinDelayMsInput() *f64
  • Type: *f64

AttemptsRequired
func Attempts() *f64
  • Type: *f64

MaxDelayMsRequired
func MaxDelayMs() *f64
  • Type: *f64

MinDelayMsRequired
func MinDelayMs() *f64
  • Type: *f64

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}