Skip to content

Latest commit

 

History

History
2119 lines (1300 loc) · 98.6 KB

logStreamingDestination.typescript.md

File metadata and controls

2119 lines (1300 loc) · 98.6 KB

logStreamingDestination Submodule

Constructs

LogStreamingDestination

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination hcp_log_streaming_destination}.

Initializers

import { logStreamingDestination } from '@cdktf/provider-hcp'

new logStreamingDestination.LogStreamingDestination(scope: Construct, id: string, config: LogStreamingDestinationConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config LogStreamingDestinationConfig No description.

scopeRequired
  • Type: constructs.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 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".
putCloudwatch No description.
putDatadog No description.
putSplunkCloud No description.
resetCloudwatch No description.
resetDatadog No description.
resetSplunkCloud No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

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: string

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putCloudwatch
public putCloudwatch(value: LogStreamingDestinationCloudwatch): void
valueRequired

putDatadog
public putDatadog(value: LogStreamingDestinationDatadog): void
valueRequired

putSplunkCloud
public putSplunkCloud(value: LogStreamingDestinationSplunkCloud): void
valueRequired

resetCloudwatch
public resetCloudwatch(): void
resetDatadog
public resetDatadog(): void
resetSplunkCloud
public resetSplunkCloud(): void

Static Functions

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

isConstruct
import { logStreamingDestination } from '@cdktf/provider-hcp'

logStreamingDestination.LogStreamingDestination.isConstruct(x: any)

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: any

Any object.


isTerraformElement
import { logStreamingDestination } from '@cdktf/provider-hcp'

logStreamingDestination.LogStreamingDestination.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { logStreamingDestination } from '@cdktf/provider-hcp'

logStreamingDestination.LogStreamingDestination.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { logStreamingDestination } from '@cdktf/provider-hcp'

logStreamingDestination.LogStreamingDestination.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing LogStreamingDestination that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
cloudwatch LogStreamingDestinationCloudwatchOutputReference No description.
datadog LogStreamingDestinationDatadogOutputReference No description.
splunkCloud LogStreamingDestinationSplunkCloudOutputReference No description.
streamingDestinationId string No description.
cloudwatchInput cdktf.IResolvable | LogStreamingDestinationCloudwatch No description.
datadogInput cdktf.IResolvable | LogStreamingDestinationDatadog No description.
nameInput string No description.
splunkCloudInput cdktf.IResolvable | LogStreamingDestinationSplunkCloud No description.
name string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

cloudwatchRequired
public readonly cloudwatch: LogStreamingDestinationCloudwatchOutputReference;

datadogRequired
public readonly datadog: LogStreamingDestinationDatadogOutputReference;

splunkCloudRequired
public readonly splunkCloud: LogStreamingDestinationSplunkCloudOutputReference;

streamingDestinationIdRequired
public readonly streamingDestinationId: string;
  • Type: string

cloudwatchInputOptional
public readonly cloudwatchInput: IResolvable | LogStreamingDestinationCloudwatch;

datadogInputOptional
public readonly datadogInput: IResolvable | LogStreamingDestinationDatadog;

nameInputOptional
public readonly nameInput: string;
  • Type: string

splunkCloudInputOptional
public readonly splunkCloudInput: IResolvable | LogStreamingDestinationSplunkCloud;

nameRequired
public readonly name: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

LogStreamingDestinationCloudwatch

Initializer

import { logStreamingDestination } from '@cdktf/provider-hcp'

const logStreamingDestinationCloudwatch: logStreamingDestination.LogStreamingDestinationCloudwatch = { ... }

Properties

Name Type Description
externalId string The external_id to provide when assuming the aws IAM role.
region string The region the CloudWatch destination is set up to stream to.
roleArn string The role_arn that will be assumed to stream logs.
logGroupName string The log_group_name of the CloudWatch destination.

externalIdRequired
public readonly externalId: string;
  • Type: string

The external_id to provide when assuming the aws IAM role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#external_id LogStreamingDestination#external_id}


regionRequired
public readonly region: string;
  • Type: string

The region the CloudWatch destination is set up to stream to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#region LogStreamingDestination#region}


roleArnRequired
public readonly roleArn: string;
  • Type: string

The role_arn that will be assumed to stream logs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#role_arn LogStreamingDestination#role_arn}


logGroupNameOptional
public readonly logGroupName: string;
  • Type: string

The log_group_name of the CloudWatch destination.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#log_group_name LogStreamingDestination#log_group_name}


LogStreamingDestinationConfig

Initializer

import { logStreamingDestination } from '@cdktf/provider-hcp'

const logStreamingDestinationConfig: logStreamingDestination.LogStreamingDestinationConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string The HCP Log Streaming Destination’s name.
cloudwatch LogStreamingDestinationCloudwatch Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#cloudwatch LogStreamingDestination#cloudwatch}.
datadog LogStreamingDestinationDatadog Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#datadog LogStreamingDestination#datadog}.
splunkCloud LogStreamingDestinationSplunkCloud Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#splunk_cloud LogStreamingDestination#splunk_cloud}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: string

The HCP Log Streaming Destination’s name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#name LogStreamingDestination#name}


cloudwatchOptional
public readonly cloudwatch: LogStreamingDestinationCloudwatch;

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#cloudwatch LogStreamingDestination#cloudwatch}.


datadogOptional
public readonly datadog: LogStreamingDestinationDatadog;

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#datadog LogStreamingDestination#datadog}.


splunkCloudOptional
public readonly splunkCloud: LogStreamingDestinationSplunkCloud;

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#splunk_cloud LogStreamingDestination#splunk_cloud}.


LogStreamingDestinationDatadog

Initializer

import { logStreamingDestination } from '@cdktf/provider-hcp'

const logStreamingDestinationDatadog: logStreamingDestination.LogStreamingDestinationDatadog = { ... }

Properties

Name Type Description
apiKey string The value for the DD-API-KEY to send when making requests to DataDog.
endpoint string The Datadog endpoint to send logs to.
applicationKey string The value for the DD-APPLICATION-KEY to send when making requests to DataDog.

apiKeyRequired
public readonly apiKey: string;
  • Type: string

The value for the DD-API-KEY to send when making requests to DataDog.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#api_key LogStreamingDestination#api_key}


endpointRequired
public readonly endpoint: string;
  • Type: string

The Datadog endpoint to send logs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#endpoint LogStreamingDestination#endpoint}


applicationKeyOptional
public readonly applicationKey: string;
  • Type: string

The value for the DD-APPLICATION-KEY to send when making requests to DataDog.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#application_key LogStreamingDestination#application_key}


LogStreamingDestinationSplunkCloud

Initializer

import { logStreamingDestination } from '@cdktf/provider-hcp'

const logStreamingDestinationSplunkCloud: logStreamingDestination.LogStreamingDestinationSplunkCloud = { ... }

Properties

Name Type Description
endpoint string The Splunk Cloud endpoint to send logs to.
token string The authentication token that will be used by the platform to access Splunk Cloud.

endpointRequired
public readonly endpoint: string;
  • Type: string

The Splunk Cloud endpoint to send logs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#endpoint LogStreamingDestination#endpoint}


tokenRequired
public readonly token: string;
  • Type: string

The authentication token that will be used by the platform to access Splunk Cloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.0/docs/resources/log_streaming_destination#token LogStreamingDestination#token}


Classes

LogStreamingDestinationCloudwatchOutputReference

Initializers

import { logStreamingDestination } from '@cdktf/provider-hcp'

new logStreamingDestination.LogStreamingDestinationCloudwatchOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.
resetLogGroupName No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetLogGroupName
public resetLogGroupName(): void

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.
externalIdInput string No description.
logGroupNameInput string No description.
regionInput string No description.
roleArnInput string No description.
externalId string No description.
logGroupName string No description.
region string No description.
roleArn string No description.
internalValue cdktf.IResolvable | LogStreamingDestinationCloudwatch No description.

creationStackRequired
public readonly 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
public readonly fqn: string;
  • Type: string

externalIdInputOptional
public readonly externalIdInput: string;
  • Type: string

logGroupNameInputOptional
public readonly logGroupNameInput: string;
  • Type: string

regionInputOptional
public readonly regionInput: string;
  • Type: string

roleArnInputOptional
public readonly roleArnInput: string;
  • Type: string

externalIdRequired
public readonly externalId: string;
  • Type: string

logGroupNameRequired
public readonly logGroupName: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

roleArnRequired
public readonly roleArn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | LogStreamingDestinationCloudwatch;

LogStreamingDestinationDatadogOutputReference

Initializers

import { logStreamingDestination } from '@cdktf/provider-hcp'

new logStreamingDestination.LogStreamingDestinationDatadogOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.
resetApplicationKey No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetApplicationKey
public resetApplicationKey(): void

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.
apiKeyInput string No description.
applicationKeyInput string No description.
endpointInput string No description.
apiKey string No description.
applicationKey string No description.
endpoint string No description.
internalValue cdktf.IResolvable | LogStreamingDestinationDatadog No description.

creationStackRequired
public readonly 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
public readonly fqn: string;
  • Type: string

apiKeyInputOptional
public readonly apiKeyInput: string;
  • Type: string

applicationKeyInputOptional
public readonly applicationKeyInput: string;
  • Type: string

endpointInputOptional
public readonly endpointInput: string;
  • Type: string

apiKeyRequired
public readonly apiKey: string;
  • Type: string

applicationKeyRequired
public readonly applicationKey: string;
  • Type: string

endpointRequired
public readonly endpoint: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | LogStreamingDestinationDatadog;

LogStreamingDestinationSplunkCloudOutputReference

Initializers

import { logStreamingDestination } from '@cdktf/provider-hcp'

new logStreamingDestination.LogStreamingDestinationSplunkCloudOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
endpointInput string No description.
tokenInput string No description.
endpoint string No description.
token string No description.
internalValue cdktf.IResolvable | LogStreamingDestinationSplunkCloud No description.

creationStackRequired
public readonly 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
public readonly fqn: string;
  • Type: string

endpointInputOptional
public readonly endpointInput: string;
  • Type: string

tokenInputOptional
public readonly tokenInput: string;
  • Type: string

endpointRequired
public readonly endpoint: string;
  • Type: string

tokenRequired
public readonly token: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | LogStreamingDestinationSplunkCloud;