CfnGuardHook

class aws_cdk.CfnGuardHook(scope, id, *, alias, execution_role, failure_mode, hook_status, rule_location, target_operations, log_bucket=None, options=None, stack_filters=None, target_filters=None)

Bases: CfnResource

The AWS::CloudFormation::GuardHook resource creates a Guard Hook with the specified attributes within your CloudFormation template.

Using the Guard domain specific language (DSL), you can author Hooks to evaluate your resources before allowing stack creation, modification, or deletion. For more information, see Guard Hooks in the AWS CloudFormation Hooks User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html
CloudformationResource:: AWS::CloudFormation::GuardHook
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_guard_hook = cdk.CfnGuardHook(self, "MyCfnGuardHook",
    alias="alias",
    execution_role="executionRole",
    failure_mode="failureMode",
    hook_status="hookStatus",
    rule_location=cdk.CfnGuardHook.S3LocationProperty(
        uri="uri",

        # the properties below are optional
        version_id="versionId"
    ),
    target_operations=["targetOperations"],

    # the properties below are optional
    log_bucket="logBucket",
    options=cdk.CfnGuardHook.OptionsProperty(
        input_params=cdk.CfnGuardHook.S3LocationProperty(
            uri="uri",

            # the properties below are optional
            version_id="versionId"
        )
    ),
    stack_filters=cdk.CfnGuardHook.StackFiltersProperty(
        filtering_criteria="filteringCriteria",

        # the properties below are optional
        stack_names=cdk.CfnGuardHook.StackNamesProperty(
            exclude=["exclude"],
            include=["include"]
        ),
        stack_roles=cdk.CfnGuardHook.StackRolesProperty(
            exclude=["exclude"],
            include=["include"]
        )
    ),
    target_filters=cdk.CfnGuardHook.TargetFiltersProperty(
        actions=["actions"],
        invocation_points=["invocationPoints"],
        target_names=["targetNames"]
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
alias (str) – The type name alias for the Hook. This alias must be unique per account and Region. The alias must be in the form Name1::Name2::Name3 and must not begin with AWS . For example, Private::Guard::MyTestHook .
execution_role (str) – The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.
failure_mode (str) – Specifies how the Hook responds when rules fail their evaluation. - FAIL : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies. - WARN : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks. Default: - “WARN”
hook_status (str) – Specifies if the Hook is ENABLED or DISABLED . Default: - “DISABLED”
rule_location (Union[IResolvable, S3LocationProperty, Dict[str, Any]]) – Specifies the S3 location of your Guard rules.
target_operations (Sequence[str]) – Specifies which type of operation the Hook is run against. Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL
log_bucket (Optional[str]) – Specifies the name of an S3 bucket to store the Guard output report. This report contains the results of your Guard rule validations.
options (Union[IResolvable, OptionsProperty, Dict[str, Any], None]) – Specifies the S3 location of your input parameters.
stack_filters (Union[IResolvable, StackFiltersProperty, Dict[str, Any], None]) – Specifies the stack level filters for the Hook.
target_filters (Union[IResolvable, TargetFiltersProperty, Dict[str, Any], None]) – Specifies the target filters for the Hook.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CloudFormation::GuardHook'

alias

The type name alias for the Hook.

This alias must be unique per account and Region.

attr_hook_arn

Returns the ARN of a Guard Hook.

CloudformationAttribute:: HookArn

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

execution_role: The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.

failure_mode: Specifies how the Hook responds when rules fail their evaluation.

hook_status: Specifies if the Hook is ENABLED or DISABLED .

log_bucket: Specifies the name of an S3 bucket to store the Guard output report.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

options: Specifies the S3 location of your input parameters.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rule_location: Specifies the S3 location of your Guard rules.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stack_filters: Specifies the stack level filters for the Hook.

target_filters: Specifies the target filters for the Hook.

target_operations: Specifies which type of operation the Hook is run against.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(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.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

OptionsProperty

class CfnGuardHook.OptionsProperty(*, input_params=None)

Bases: object

Specifies the input parameters for a Guard Hook.

Parameters:: input_params (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Specifies the S3 location where your input parameters are located.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-options.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

options_property = cdk.CfnGuardHook.OptionsProperty(
    input_params=cdk.CfnGuardHook.S3LocationProperty(
        uri="uri",

        # the properties below are optional
        version_id="versionId"
    )
)

Attributes

input_params

Specifies the S3 location where your input parameters are located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-options.html#cfn-cloudformation-guardhook-options-inputparams

S3LocationProperty

class CfnGuardHook.S3LocationProperty(*, uri, version_id=None)

Bases: object

Specifies the S3 location where your Guard rules or input parameters are located.

Parameters:

uri (str) – Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ). For Guard rules, the object stored in S3 must have one of the following file extensions: .guard , .zip , or .tar.gz . For input parameters, the object stored in S3 must have one of the following file extensions: .yaml , .json , .zip , or .tar.gz .
version_id (Optional[str]) – For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from. The Guard Hook downloads files from S3 every time the Hook is invoked. To prevent accidental changes or deletions, we recommend using a version when configuring your Guard Hook.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

s3_location_property = cdk.CfnGuardHook.S3LocationProperty(
    uri="uri",

    # the properties below are optional
    version_id="versionId"
)

Attributes

uri

Specifies the S3 path to the file containing your Guard rules or input parameters (in the form s3://<bucket name>/<file name> ).

For Guard rules, the object stored in S3 must have one of the following file extensions: .guard , .zip , or .tar.gz .

For input parameters, the object stored in S3 must have one of the following file extensions: .yaml , .json , .zip , or .tar.gz .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-uri

version_id

For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.

The Guard Hook downloads files from S3 every time the Hook is invoked. To prevent accidental changes or deletions, we recommend using a version when configuring your Guard Hook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-versionid

StackFiltersProperty

class CfnGuardHook.StackFiltersProperty(*, filtering_criteria, stack_names=None, stack_roles=None)

Bases: object

The StackFilters property type specifies stack level filters for a Hook.

The StackNames or StackRoles properties are optional. However, you must specify at least one of these properties.

For more information, see AWS CloudFormation Hooks stack level filters .

Parameters:

filtering_criteria (str) – The filtering criteria. - All stack names and stack roles ( All ): The Hook will only be invoked when all specified filters match. - Any stack names and stack roles ( Any ): The Hook will be invoked if at least one of the specified filters match. Default: - “ALL”
stack_names (Union[IResolvable, StackNamesProperty, Dict[str, Any], None]) – Includes or excludes specific stacks from Hook invocations.
stack_roles (Union[IResolvable, StackRolesProperty, Dict[str, Any], None]) – Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

stack_filters_property = cdk.CfnGuardHook.StackFiltersProperty(
    filtering_criteria="filteringCriteria",

    # the properties below are optional
    stack_names=cdk.CfnGuardHook.StackNamesProperty(
        exclude=["exclude"],
        include=["include"]
    ),
    stack_roles=cdk.CfnGuardHook.StackRolesProperty(
        exclude=["exclude"],
        include=["include"]
    )
)

Attributes

filtering_criteria

The filtering criteria.

All stack names and stack roles ( All ): The Hook will only be invoked when all specified filters match.
Any stack names and stack roles ( Any ): The Hook will be invoked if at least one of the specified filters match.

Default:

“ALL”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-filteringcriteria

stack_names

Includes or excludes specific stacks from Hook invocations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stacknames

stack_roles

Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stackroles

StackNamesProperty

class CfnGuardHook.StackNamesProperty(*, exclude=None, include=None)

Bases: object

Specifies the stack names for the StackFilters property type to include or exclude specific stacks from Hook invocations.

For more information, see AWS CloudFormation Hooks stack level filters .

Parameters:

exclude (Optional[Sequence[str]]) – The stack names to exclude. All stacks except those listed here will invoke the Hook.
include (Optional[Sequence[str]]) – The stack names to include. Only the stacks specified in this list will invoke the Hook.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

stack_names_property = cdk.CfnGuardHook.StackNamesProperty(
    exclude=["exclude"],
    include=["include"]
)

Attributes

exclude

The stack names to exclude.

All stacks except those listed here will invoke the Hook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-exclude

include

The stack names to include.

Only the stacks specified in this list will invoke the Hook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-include

StackRolesProperty

class CfnGuardHook.StackRolesProperty(*, exclude=None, include=None)

Bases: object

Specifies the stack roles for the StackFilters property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.

For more information, see AWS CloudFormation Hooks stack level filters .

Parameters:

exclude (Optional[Sequence[str]]) – The IAM role ARNs for stacks you want to exclude. The Hook will be invoked on all stacks except those initiated by the specified roles.
include (Optional[Sequence[str]]) – The IAM role ARNs to target stacks associated with these roles. Only stack operations initiated by these roles will invoke the Hook.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

stack_roles_property = cdk.CfnGuardHook.StackRolesProperty(
    exclude=["exclude"],
    include=["include"]
)

Attributes

exclude

The IAM role ARNs for stacks you want to exclude.

The Hook will be invoked on all stacks except those initiated by the specified roles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-exclude

include

The IAM role ARNs to target stacks associated with these roles.

Only stack operations initiated by these roles will invoke the Hook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-include

TargetFiltersProperty

class CfnGuardHook.TargetFiltersProperty(*, actions=None, invocation_points=None, target_names=None)

Bases: object

The TargetFilters property type specifies the target filters for the Hook.

For more information, see AWS CloudFormation Hook target filters .

Parameters:

actions (Optional[Sequence[str]]) – List of actions that the hook is going to target.
invocation_points (Optional[Sequence[str]]) – List of invocation points that the hook is going to target.
target_names (Optional[Sequence[str]]) – List of type names that the hook is going to target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

target_filters_property = cdk.CfnGuardHook.TargetFiltersProperty(
    actions=["actions"],
    invocation_points=["invocationPoints"],
    target_names=["targetNames"]
)

Attributes

actions

List of actions that the hook is going to target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-actions

invocation_points

List of invocation points that the hook is going to target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-invocationpoints

target_names

List of type names that the hook is going to target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-targetnames