xraySamplingRule.md

aws_xray_sampling_rule

Refer to the Terraform Registory for docs: aws_xray_sampling_rule.

xraySamplingRule Submodule

Constructs

XraySamplingRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule aws_xray_sampling_rule}.

Initializers

import { xraySamplingRule } from '@cdktf/aws-cdk'

new xraySamplingRule.XraySamplingRule(scope: Construct, id: string, config: XraySamplingRuleConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	XraySamplingRuleConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: XraySamplingRuleConfig

---

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.
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.
resetAttributes	No description.
resetId	No description.
resetRuleName	No description.
resetTags	No description.
resetTagsAll	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetAttributes

public resetAttributes(): void

resetId

public resetId(): void

resetRuleName

public resetRuleName(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.

---

isConstruct

import { xraySamplingRule } from '@cdktf/aws-cdk'

xraySamplingRule.XraySamplingRule.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { xraySamplingRule } from '@cdktf/aws-cdk'

xraySamplingRule.XraySamplingRule.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { xraySamplingRule } from '@cdktf/aws-cdk'

xraySamplingRule.XraySamplingRule.isTerraformResource(x: any)

x^Required

• Type: any

---

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.
arn	string	No description.
attributesInput	{[ key: string ]: string}	No description.
fixedRateInput	number	No description.
hostInput	string	No description.
httpMethodInput	string	No description.
idInput	string	No description.
priorityInput	number	No description.
reservoirSizeInput	number	No description.
resourceArnInput	string	No description.
ruleNameInput	string	No description.
serviceNameInput	string	No description.
serviceTypeInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
urlPathInput	string	No description.
versionInput	number	No description.
attributes	{[ key: string ]: string}	No description.
fixedRate	number	No description.
host	string	No description.
httpMethod	string	No description.
id	string	No description.
priority	number	No description.
reservoirSize	number	No description.
resourceArn	string	No description.
ruleName	string	No description.
serviceName	string	No description.
serviceType	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
urlPath	string	No description.
version	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

attributesInput^Optional

public readonly attributesInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

fixedRateInput^Optional

public readonly fixedRateInput: number;

• Type: number

---

hostInput^Optional

public readonly hostInput: string;

• Type: string

---

httpMethodInput^Optional

public readonly httpMethodInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

priorityInput^Optional

public readonly priorityInput: number;

• Type: number

---

reservoirSizeInput^Optional

public readonly reservoirSizeInput: number;

• Type: number

---

resourceArnInput^Optional

public readonly resourceArnInput: string;

• Type: string

---

ruleNameInput^Optional

public readonly ruleNameInput: string;

• Type: string

---

serviceNameInput^Optional

public readonly serviceNameInput: string;

• Type: string

---

serviceTypeInput^Optional

public readonly serviceTypeInput: string;

• Type: string

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

urlPathInput^Optional

public readonly urlPathInput: string;

• Type: string

---

versionInput^Optional

public readonly versionInput: number;

• Type: number

---

attributes^Required

public readonly attributes: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

fixedRate^Required

public readonly fixedRate: number;

• Type: number

---

host^Required

public readonly host: string;

• Type: string

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

priority^Required

public readonly priority: number;

• Type: number

---

reservoirSize^Required

public readonly reservoirSize: number;

• Type: number

---

resourceArn^Required

public readonly resourceArn: string;

• Type: string

---

ruleName^Required

public readonly ruleName: string;

• Type: string

---

serviceName^Required

public readonly serviceName: string;

• Type: string

---

serviceType^Required

public readonly serviceType: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

urlPath^Required

public readonly urlPath: string;

• Type: string

---

version^Required

public readonly version: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

XraySamplingRuleConfig

Initializer

import { xraySamplingRule } from '@cdktf/aws-cdk'

const xraySamplingRuleConfig: xraySamplingRule.XraySamplingRuleConfig = { ... }

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.
fixedRate	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#fixed_rate XraySamplingRule#fixed_rate}.
host	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#host XraySamplingRule#host}.
httpMethod	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#http_method XraySamplingRule#http_method}.
priority	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#priority XraySamplingRule#priority}.
reservoirSize	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#reservoir_size XraySamplingRule#reservoir_size}.
resourceArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#resource_arn XraySamplingRule#resource_arn}.
serviceName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#service_name XraySamplingRule#service_name}.
serviceType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#service_type XraySamplingRule#service_type}.
urlPath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#url_path XraySamplingRule#url_path}.
version	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#version XraySamplingRule#version}.
attributes	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#attributes XraySamplingRule#attributes}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#id XraySamplingRule#id}.
ruleName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#rule_name XraySamplingRule#rule_name}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#tags XraySamplingRule#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#tags_all XraySamplingRule#tags_all}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

fixedRate^Required

public readonly fixedRate: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#fixed_rate XraySamplingRule#fixed_rate}.

---

host^Required

public readonly host: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#host XraySamplingRule#host}.

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#http_method XraySamplingRule#http_method}.

---

priority^Required

public readonly priority: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#priority XraySamplingRule#priority}.

---

reservoirSize^Required

public readonly reservoirSize: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#reservoir_size XraySamplingRule#reservoir_size}.

---

resourceArn^Required

public readonly resourceArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#resource_arn XraySamplingRule#resource_arn}.

---

serviceName^Required

public readonly serviceName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#service_name XraySamplingRule#service_name}.

---

serviceType^Required

public readonly serviceType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#service_type XraySamplingRule#service_type}.

---

urlPath^Required

public readonly urlPath: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#url_path XraySamplingRule#url_path}.

---

version^Required

public readonly version: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#version XraySamplingRule#version}.

---

attributes^Optional

public readonly attributes: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#attributes XraySamplingRule#attributes}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#id XraySamplingRule#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.

---

ruleName^Optional

public readonly ruleName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#rule_name XraySamplingRule#rule_name}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#tags XraySamplingRule#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/xray_sampling_rule#tags_all XraySamplingRule#tags_all}.

---