xraySamplingRule.csharp.md

xraySamplingRule Submodule

Constructs

XraySamplingRule

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

Initializers

using HashiCorp.Cdktf.Providers.Aws;

new XraySamplingRule(Construct Scope, string Id, XraySamplingRuleConfig Config);

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.
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".
ResetAttributes	No description.
ResetId	No description.
ResetRuleName	No description.
ResetTags	No description.
ResetTagsAll	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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.

Id^Required

• Type: string

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

---

MoveTo

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

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

---

Index^Optional

• Type: object

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

---

MoveToId

private void MoveToId(string Id)

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

Id^Required

• Type: string

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

---

ResetAttributes

private void ResetAttributes()

ResetId

private void ResetId()

ResetRuleName

private void ResetRuleName()

ResetTags

private void ResetTags()

ResetTagsAll

private void ResetTagsAll()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Aws;

XraySamplingRule.IsConstruct(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.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Aws;

XraySamplingRule.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Aws;

XraySamplingRule.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Aws;

XraySamplingRule.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

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

---

ImportFromId^Required

• Type: string

The id of the existing XraySamplingRule that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Arn	string	No description.
AttributesInput	System.Collections.Generic.IDictionary<string, string>	No description.
FixedRateInput	double	No description.
HostInput	string	No description.
HttpMethodInput	string	No description.
IdInput	string	No description.
PriorityInput	double	No description.
ReservoirSizeInput	double	No description.
ResourceArnInput	string	No description.
RuleNameInput	string	No description.
ServiceNameInput	string	No description.
ServiceTypeInput	string	No description.
TagsAllInput	System.Collections.Generic.IDictionary<string, string>	No description.
TagsInput	System.Collections.Generic.IDictionary<string, string>	No description.
UrlPathInput	string	No description.
VersionInput	double	No description.
Attributes	System.Collections.Generic.IDictionary<string, string>	No description.
FixedRate	double	No description.
Host	string	No description.
HttpMethod	string	No description.
Id	string	No description.
Priority	double	No description.
ReservoirSize	double	No description.
ResourceArn	string	No description.
RuleName	string	No description.
ServiceName	string	No description.
ServiceType	string	No description.
Tags	System.Collections.Generic.IDictionary<string, string>	No description.
TagsAll	System.Collections.Generic.IDictionary<string, string>	No description.
UrlPath	string	No description.
Version	double	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

Arn^Required

public string Arn { get; }

• Type: string

---

AttributesInput^Optional

public System.Collections.Generic.IDictionary<string, string> AttributesInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

FixedRateInput^Optional

public double FixedRateInput { get; }

• Type: double

---

HostInput^Optional

public string HostInput { get; }

• Type: string

---

HttpMethodInput^Optional

public string HttpMethodInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

PriorityInput^Optional

public double PriorityInput { get; }

• Type: double

---

ReservoirSizeInput^Optional

public double ReservoirSizeInput { get; }

• Type: double

---

ResourceArnInput^Optional

public string ResourceArnInput { get; }

• Type: string

---

RuleNameInput^Optional

public string RuleNameInput { get; }

• Type: string

---

ServiceNameInput^Optional

public string ServiceNameInput { get; }

• Type: string

---

ServiceTypeInput^Optional

public string ServiceTypeInput { get; }

• Type: string

---

TagsAllInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAllInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsInput^Optional

public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

UrlPathInput^Optional

public string UrlPathInput { get; }

• Type: string

---

VersionInput^Optional

public double VersionInput { get; }

• Type: double

---

Attributes^Required

public System.Collections.Generic.IDictionary<string, string> Attributes { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

FixedRate^Required

public double FixedRate { get; }

• Type: double

---

Host^Required

public string Host { get; }

• Type: string

---

HttpMethod^Required

public string HttpMethod { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

Priority^Required

public double Priority { get; }

• Type: double

---

ReservoirSize^Required

public double ReservoirSize { get; }

• Type: double

---

ResourceArn^Required

public string ResourceArn { get; }

• Type: string

---

RuleName^Required

public string RuleName { get; }

• Type: string

---

ServiceName^Required

public string ServiceName { get; }

• Type: string

---

ServiceType^Required

public string ServiceType { get; }

• Type: string

---

Tags^Required

public System.Collections.Generic.IDictionary<string, string> Tags { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

TagsAll^Required

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; }

• Type: System.Collections.Generic.IDictionary<string, string>

---

UrlPath^Required

public string UrlPath { get; }

• Type: string

---

Version^Required

public double Version { get; }

• Type: double

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

XraySamplingRuleConfig

Initializer

using HashiCorp.Cdktf.Providers.Aws;

new XraySamplingRuleConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    double FixedRate,
    string Host,
    string HttpMethod,
    double Priority,
    double ReservoirSize,
    string ResourceArn,
    string ServiceName,
    string ServiceType,
    string UrlPath,
    double Version,
    System.Collections.Generic.IDictionary<string, string> Attributes = null,
    string Id = null,
    string RuleName = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    System.Collections.Generic.IDictionary<string, string> TagsAll = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
FixedRate	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#fixed_rate XraySamplingRule#fixed_rate}.
Host	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#host XraySamplingRule#host}.
HttpMethod	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#http_method XraySamplingRule#http_method}.
Priority	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#priority XraySamplingRule#priority}.
ReservoirSize	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#reservoir_size XraySamplingRule#reservoir_size}.
ResourceArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#resource_arn XraySamplingRule#resource_arn}.
ServiceName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#service_name XraySamplingRule#service_name}.
ServiceType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#service_type XraySamplingRule#service_type}.
UrlPath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#url_path XraySamplingRule#url_path}.
Version	double	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#version XraySamplingRule#version}.
Attributes	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#attributes XraySamplingRule#attributes}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#id XraySamplingRule#id}.
RuleName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#rule_name XraySamplingRule#rule_name}.
Tags	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#tags XraySamplingRule#tags}.
TagsAll	System.Collections.Generic.IDictionary<string, string>	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/docs/resources/xray_sampling_rule#tags_all XraySamplingRule#tags_all}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

FixedRate^Required

public double FixedRate { get; set; }

• Type: double

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

---

Host^Required

public string Host { get; set; }

• Type: string

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

---

HttpMethod^Required

public string HttpMethod { get; set; }

• Type: string

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

---

Priority^Required

public double Priority { get; set; }

• Type: double

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

---

ReservoirSize^Required

public double ReservoirSize { get; set; }

• Type: double

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

---

ResourceArn^Required

public string ResourceArn { get; set; }

• Type: string

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

---

ServiceName^Required

public string ServiceName { get; set; }

• Type: string

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

---

ServiceType^Required

public string ServiceType { get; set; }

• Type: string

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

---

UrlPath^Required

public string UrlPath { get; set; }

• Type: string

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

---

Version^Required

public double Version { get; set; }

• Type: double

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

---

Attributes^Optional

public System.Collections.Generic.IDictionary<string, string> Attributes { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.52.0/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 string RuleName { get; set; }

• Type: string

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

---

Tags^Optional

public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---

TagsAll^Optional

public System.Collections.Generic.IDictionary<string, string> TagsAll { get; set; }

• Type: System.Collections.Generic.IDictionary<string, string>

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

---