Skip to content

ICustomResponseCodeRule

Represents a CustomResponseCodeRule.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_config_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ConfigId: Config Id.
attr_config_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ConfigType: The configuration type.
attr_page_id typing.Union[str, ros_cdk_core.IResolvable] Attribute PageId: The custom response page.
attr_return_code typing.Union[str, ros_cdk_core.IResolvable] Attribute ReturnCode: The custom response code.
attr_rule typing.Union[str, ros_cdk_core.IResolvable] Attribute Rule: Rule content, using conditional expressions to match user requests.
attr_rule_enable typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleEnable: Rule switch.
attr_rule_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleName: Rule name.
attr_sequence typing.Union[str, ros_cdk_core.IResolvable] Attribute Sequence: Order of rule execution.
attr_site_version typing.Union[str, ros_cdk_core.IResolvable] Attribute SiteVersion: The version number of the site configuration.
props CustomResponseCodeRuleProps No description.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.

envRequired 

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

attr_config_idRequired 

attr_config_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ConfigId: Config Id.

attr_config_typeRequired 

attr_config_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ConfigType: The configuration type.

You can use this parameter to check the global configuration or rule configuration.

attr_page_idRequired 

attr_page_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PageId: The custom response page.

attr_return_codeRequired 

attr_return_code: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ReturnCode: The custom response code.

attr_ruleRequired 

attr_rule: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set.

attr_rule_enableRequired 

attr_rule_enable: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set.

attr_rule_nameRequired 

attr_rule_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleName: Rule name.

When adding global configuration, this parameter does not need to be set.

attr_sequenceRequired 

attr_sequence: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.

attr_site_versionRequired 

attr_site_version: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SiteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.

propsRequired 

props: CustomResponseCodeRuleProps