`xraySamplingRule` Submodule

Constructs

XraySamplingRule

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

Initializers

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRule(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  fixed_rate: typing.Union[int, float],
  host: str,
  http_method: str,
  priority: typing.Union[int, float],
  reservoir_size: typing.Union[int, float],
  resource_arn: str,
  service_name: str,
  service_type: str,
  url_path: str,
  version: typing.Union[int, float],
  attributes: typing.Mapping[str] = None,
  id: str = None,
  region: str = None,
  rule_name: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`fixed_rate`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#fixed_rate XraySamplingRule#fixed_rate}.
`host`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#host XraySamplingRule#host}.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#http_method XraySamplingRule#http_method}.
`priority`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#priority XraySamplingRule#priority}.
`reservoir_size`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#reservoir_size XraySamplingRule#reservoir_size}.
`resource_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#resource_arn XraySamplingRule#resource_arn}.
`service_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#service_name XraySamplingRule#service_name}.
`service_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#service_type XraySamplingRule#service_type}.
`url_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#url_path XraySamplingRule#url_path}.
`version`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#version XraySamplingRule#version}.
`attributes`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#attributes XraySamplingRule#attributes}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#id XraySamplingRule#id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`rule_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#rule_name XraySamplingRule#rule_name}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#tags XraySamplingRule#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#tags_all XraySamplingRule#tags_all}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`fixed_rate`^Required

Type: typing.Union[int, float]

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

`host`^Required

Type: str

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

`http_method`^Required

Type: str

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

`priority`^Required

Type: typing.Union[int, float]

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

`reservoir_size`^Required

Type: typing.Union[int, float]

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

`resource_arn`^Required

Type: str

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

`service_name`^Required

Type: str

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

`service_type`^Required

Type: str

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

`url_path`^Required

Type: str

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

`version`^Required

Type: typing.Union[int, float]

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

`attributes`^Optional

Type: typing.Mapping[str]

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

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.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.

`region`^Optional

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`rule_name`^Optional

Type: str

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

`tags`^Optional

Type: typing.Mapping[str]

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

`tags_all`^Optional

Type: typing.Mapping[str]

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`reset_attributes`	No description.
`reset_id`	No description.
`reset_region`	No description.
`reset_rule_name`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`reset_attributes`

def reset_attributes() -> None

`reset_id`

def reset_id() -> None

`reset_region`

def reset_region() -> None

`reset_rule_name`

def reset_rule_name() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a XraySamplingRule resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRule.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRule.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRule.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRule.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a XraySamplingRule resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing XraySamplingRule that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`attributes_input`	`typing.Mapping[str]`	No description.
`fixed_rate_input`	`typing.Union[int, float]`	No description.
`host_input`	`str`	No description.
`http_method_input`	`str`	No description.
`id_input`	`str`	No description.
`priority_input`	`typing.Union[int, float]`	No description.
`region_input`	`str`	No description.
`reservoir_size_input`	`typing.Union[int, float]`	No description.
`resource_arn_input`	`str`	No description.
`rule_name_input`	`str`	No description.
`service_name_input`	`str`	No description.
`service_type_input`	`str`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`url_path_input`	`str`	No description.
`version_input`	`typing.Union[int, float]`	No description.
`attributes`	`typing.Mapping[str]`	No description.
`fixed_rate`	`typing.Union[int, float]`	No description.
`host`	`str`	No description.
`http_method`	`str`	No description.
`id`	`str`	No description.
`priority`	`typing.Union[int, float]`	No description.
`region`	`str`	No description.
`reservoir_size`	`typing.Union[int, float]`	No description.
`resource_arn`	`str`	No description.
`rule_name`	`str`	No description.
`service_name`	`str`	No description.
`service_type`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.
`url_path`	`str`	No description.
`version`	`typing.Union[int, float]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`attributes_input`^Optional

attributes_input: typing.Mapping[str]

Type: typing.Mapping[str]

`fixed_rate_input`^Optional

fixed_rate_input: typing.Union[int, float]

Type: typing.Union[int, float]

`host_input`^Optional

host_input: str

Type: str

`http_method_input`^Optional

http_method_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`priority_input`^Optional

priority_input: typing.Union[int, float]

Type: typing.Union[int, float]

`region_input`^Optional

region_input: str

Type: str

`reservoir_size_input`^Optional

reservoir_size_input: typing.Union[int, float]

Type: typing.Union[int, float]

`resource_arn_input`^Optional

resource_arn_input: str

Type: str

`rule_name_input`^Optional

rule_name_input: str

Type: str

`service_name_input`^Optional

service_name_input: str

Type: str

`service_type_input`^Optional

service_type_input: str

Type: str

`tags_all_input`^Optional

tags_all_input: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`url_path_input`^Optional

url_path_input: str

Type: str

`version_input`^Optional

version_input: typing.Union[int, float]

Type: typing.Union[int, float]

`attributes`^Required

attributes: typing.Mapping[str]

Type: typing.Mapping[str]

`fixed_rate`^Required

fixed_rate: typing.Union[int, float]

Type: typing.Union[int, float]

`host`^Required

host: str

Type: str

`http_method`^Required

http_method: str

Type: str

`id`^Required

id: str

Type: str

`priority`^Required

priority: typing.Union[int, float]

Type: typing.Union[int, float]

`region`^Required

region: str

Type: str

`reservoir_size`^Required

reservoir_size: typing.Union[int, float]

Type: typing.Union[int, float]

`resource_arn`^Required

resource_arn: str

Type: str

`rule_name`^Required

rule_name: str

Type: str

`service_name`^Required

service_name: str

Type: str

`service_type`^Required

service_type: str

Type: str

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_all`^Required

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

`url_path`^Required

url_path: str

Type: str

`version`^Required

version: typing.Union[int, float]

Type: typing.Union[int, float]

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

XraySamplingRuleConfig

Initializer

from cdktn_provider_aws import xray_sampling_rule

xraySamplingRule.XraySamplingRuleConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  fixed_rate: typing.Union[int, float],
  host: str,
  http_method: str,
  priority: typing.Union[int, float],
  reservoir_size: typing.Union[int, float],
  resource_arn: str,
  service_name: str,
  service_type: str,
  url_path: str,
  version: typing.Union[int, float],
  attributes: typing.Mapping[str] = None,
  id: str = None,
  region: str = None,
  rule_name: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`fixed_rate`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#fixed_rate XraySamplingRule#fixed_rate}.
`host`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#host XraySamplingRule#host}.
`http_method`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#http_method XraySamplingRule#http_method}.
`priority`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#priority XraySamplingRule#priority}.
`reservoir_size`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#reservoir_size XraySamplingRule#reservoir_size}.
`resource_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#resource_arn XraySamplingRule#resource_arn}.
`service_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#service_name XraySamplingRule#service_name}.
`service_type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#service_type XraySamplingRule#service_type}.
`url_path`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#url_path XraySamplingRule#url_path}.
`version`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#version XraySamplingRule#version}.
`attributes`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#attributes XraySamplingRule#attributes}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#id XraySamplingRule#id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`rule_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#rule_name XraySamplingRule#rule_name}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#tags XraySamplingRule#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/xray_sampling_rule#tags_all XraySamplingRule#tags_all}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`fixed_rate`^Required

fixed_rate: typing.Union[int, float]

Type: typing.Union[int, float]

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

`host`^Required

host: str

Type: str

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

`http_method`^Required

http_method: str

Type: str

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

`priority`^Required

priority: typing.Union[int, float]

Type: typing.Union[int, float]

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

`reservoir_size`^Required

reservoir_size: typing.Union[int, float]

Type: typing.Union[int, float]

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

`resource_arn`^Required

resource_arn: str

Type: str

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

`service_name`^Required

service_name: str

Type: str

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

`service_type`^Required

service_type: str

Type: str

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

`url_path`^Required

url_path: str

Type: str

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

`version`^Required

version: typing.Union[int, float]

Type: typing.Union[int, float]

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

`attributes`^Optional

attributes: typing.Mapping[str]

Type: typing.Mapping[str]

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

`id`^Optional

id: str

Type: str

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

`region`^Optional

region: str

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`rule_name`^Optional

rule_name: str

Type: str

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

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

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

`tags_all`^Optional

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

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

FilesExpand file tree

xraySamplingRule.python.md

Latest commit

History

xraySamplingRule.python.md

File metadata and controls

xraySamplingRule Submodule

Constructs