CfnService

class aws_cdk.aws_resiliencehubv2.CfnService(scope, id, *, name, regions, assertions=None, associated_systems=None, dependency_discovery=None, description=None, input_sources=None, kms_key_id=None, permission_model=None, policy_arn=None, report_configuration=None, tags=None)

Bases: CfnResource

Creates a resilience-managed service with associated systems, input sources, assertions, and service functions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html

CloudformationResource:

AWS::ResilienceHubV2::Service

ExampleMetadata:

fixture=_generated

Example:

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

cfn_service = resiliencehubv2.CfnService(self, "MyCfnService",
    name="name",
    regions=["regions"],

    # the properties below are optional
    assertions=[resiliencehubv2.CfnService.AssertionDefinitionProperty(
        text="text"
    )],
    associated_systems=[resiliencehubv2.CfnService.AssociatedSystemProperty(
        system_arn="systemArn",

        # the properties below are optional
        user_journey_ids=["userJourneyIds"]
    )],
    dependency_discovery="dependencyDiscovery",
    description="description",
    input_sources=[resiliencehubv2.CfnService.InputSourceDefinitionProperty(
        resource_configuration=resiliencehubv2.CfnService.ResourceConfigurationProperty(
            cfn_stack_arn="cfnStackArn",
            design_file_s3_url="designFileS3Url",
            eks=resiliencehubv2.CfnService.EksSourceProperty(
                cluster_arn="clusterArn",
                namespaces=["namespaces"]
            ),
            resource_tags=[resiliencehubv2.CfnService.ResourceTagProperty(
                key="key",
                values=["values"]
            )],
            tf_state_file_url="tfStateFileUrl"
        )
    )],
    kms_key_id="kmsKeyId",
    permission_model=resiliencehubv2.CfnService.PermissionModelProperty(
        invoker_role_name="invokerRoleName",

        # the properties below are optional
        cross_account_role_arns=[resiliencehubv2.CfnService.CrossAccountRoleConfigurationProperty(
            cross_account_role_arn="crossAccountRoleArn",

            # the properties below are optional
            external_id="externalId"
        )]
    ),
    policy_arn="policyArn",
    report_configuration=resiliencehubv2.CfnService.ServiceReportConfigurationProperty(
        report_output=[resiliencehubv2.CfnService.ReportOutputConfigurationProperty(
            s3=resiliencehubv2.CfnService.S3ReportOutputConfigurationProperty(
                bucket_owner="bucketOwner",
                bucket_path="bucketPath"
            )
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::ResilienceHubV2::Service.

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• name (str) – The name of the service.

• regions (Sequence[str]) – AWS regions for the service.

• assertions (Union[IResolvable, Sequence[Union[IResolvable, AssertionDefinitionProperty, Dict[str, Any]]], None]) – Assertions associated with this service.

• associated_systems (Union[IResolvable, Sequence[Union[IResolvable, AssociatedSystemProperty, Dict[str, Any]]], None]) – Systems associated with this service.

• dependency_discovery (Optional[str]) – Dependency discovery state.

• description (Optional[str]) – The description of the service.

• input_sources (Union[IResolvable, Sequence[Union[IResolvable, InputSourceDefinitionProperty, Dict[str, Any]]], None]) – Input sources for this service.

• kms_key_id (Optional[str]) – The KMS key ID for encrypting service data.

• permission_model (Union[IResolvable, PermissionModelProperty, Dict[str, Any], None])

• policy_arn (Optional[str]) – The ARN of the resilience policy to associate.

• report_configuration (Union[IResolvable, ServiceReportConfigurationProperty, Dict[str, Any], None]) – Configuration for automatic report generation on a Service.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags assigned to the service.

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_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

• The reference strength to use for this resource.

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

cfn_property_name(cdk_property_name)

Parameters:

cdk_property_name (str)

Return type:

Optional[str]

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[CfnResource, Stack]]

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

with_(*mixins)

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.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ResilienceHubV2::Service'

assertions

Assertions associated with this service.

associated_systems

Systems associated with this service.

attr_created_at

The timestamp when the service was created.

CloudformationAttribute:

CreatedAt

attr_effective_policy_values

Effective policy values computed from the associated policy.

CloudformationAttribute:

EffectivePolicyValues

attr_service_arn

The ARN of the service.

CloudformationAttribute:

ServiceArn

attr_updated_at

The timestamp when the service was last updated.

CloudformationAttribute:

UpdatedAt

cdk_tag_manager

Tag Manager which manages the tags for this resource.

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.

dependency_discovery

Dependency discovery state.

description

The description of the service.

env

input_sources

Input sources for this service.

kms_key_id

The KMS key ID for encrypting service data.

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.

name

The name of the service.

node

The tree node.

permission_model

policy_arn

The ARN of the resilience policy to associate.

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 }).

regions

AWS regions for the service.

report_configuration

Configuration for automatic report generation on a Service.

service_ref

A reference to a Service resource.

stack

The stack in which this element is defined.

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

tags

Tags assigned to the service.

Static Methods

classmethod arn_for_service(resource)

Parameters:

resource (IServiceRef)

Return type:

str

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_cfn_service(x)

Checks whether the given object is a CfnService.

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.

AssertionDefinitionProperty

class CfnService.AssertionDefinitionProperty(*, text)

Bases: object

An assertion about the service’s resilience posture.

Parameters:

text (str) – The text of the assertion.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-assertiondefinition.html

ExampleMetadata:

fixture=_generated

Example:

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

assertion_definition_property = resiliencehubv2.CfnService.AssertionDefinitionProperty(
    text="text"
)

Attributes

text

The text of the assertion.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-assertiondefinition.html#cfn-resiliencehubv2-service-assertiondefinition-text

AssociatedSystemProperty

class CfnService.AssociatedSystemProperty(*, system_arn, user_journey_ids=None)

Bases: object

Parameters:

• system_arn (str) – The system ARN.

• user_journey_ids (Optional[Sequence[str]]) – User journey IDs associated with this system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-associatedsystem.html

ExampleMetadata:

fixture=_generated

Example:

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

associated_system_property = resiliencehubv2.CfnService.AssociatedSystemProperty(
    system_arn="systemArn",

    # the properties below are optional
    user_journey_ids=["userJourneyIds"]
)

Attributes

system_arn

The system ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-associatedsystem.html#cfn-resiliencehubv2-service-associatedsystem-systemarn

user_journey_ids

User journey IDs associated with this system.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-associatedsystem.html#cfn-resiliencehubv2-service-associatedsystem-userjourneyids

CrossAccountRoleConfigurationProperty

class CfnService.CrossAccountRoleConfigurationProperty(*, cross_account_role_arn, external_id=None)

Bases: object

Parameters:

• cross_account_role_arn (str) – ARN of the cross-account IAM role.

• external_id (Optional[str]) – External ID for cross-account access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-crossaccountroleconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

cross_account_role_configuration_property = resiliencehubv2.CfnService.CrossAccountRoleConfigurationProperty(
    cross_account_role_arn="crossAccountRoleArn",

    # the properties below are optional
    external_id="externalId"
)

Attributes

cross_account_role_arn

ARN of the cross-account IAM role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-crossaccountroleconfiguration.html#cfn-resiliencehubv2-service-crossaccountroleconfiguration-crossaccountrolearn

external_id

External ID for cross-account access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-crossaccountroleconfiguration.html#cfn-resiliencehubv2-service-crossaccountroleconfiguration-externalid

DisasterRecoverySourceProperty

class CfnService.DisasterRecoverySourceProperty(*, policy_name=None, value=None)

Bases: object

Parameters:

• policy_name (Optional[str])

• value (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html

ExampleMetadata:

fixture=_generated

Example:

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

disaster_recovery_source_property = resiliencehubv2.CfnService.DisasterRecoverySourceProperty(
    policy_name="policyName",
    value="value"
)

Attributes

policy_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html#cfn-resiliencehubv2-service-disasterrecoverysource-policyname

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html#cfn-resiliencehubv2-service-disasterrecoverysource-value

Type:

see

EffectivePolicyValuesProperty

class CfnService.EffectivePolicyValuesProperty(*, availability_slo=None, multi_az_dr_approach=None, multi_az_rpo=None, multi_az_rto=None, multi_region_dr_approach=None, multi_region_rpo=None, multi_region_rto=None)

Bases: object

Effective policy values computed from the associated policy.

Parameters:

• availability_slo (Union[IResolvable, SloSourceProperty, Dict[str, Any], None])

• multi_az_dr_approach (Union[IResolvable, DisasterRecoverySourceProperty, Dict[str, Any], None])

• multi_az_rpo (Union[IResolvable, TargetSourceProperty, Dict[str, Any], None])

• multi_az_rto (Union[IResolvable, TargetSourceProperty, Dict[str, Any], None])

• multi_region_dr_approach (Union[IResolvable, DisasterRecoverySourceProperty, Dict[str, Any], None])

• multi_region_rpo (Union[IResolvable, TargetSourceProperty, Dict[str, Any], None])

• multi_region_rto (Union[IResolvable, TargetSourceProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html

ExampleMetadata:

fixture=_generated

Example:

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

effective_policy_values_property = resiliencehubv2.CfnService.EffectivePolicyValuesProperty(
    availability_slo=resiliencehubv2.CfnService.SloSourceProperty(
        policy_name="policyName",
        value=123
    ),
    multi_az_dr_approach=resiliencehubv2.CfnService.DisasterRecoverySourceProperty(
        policy_name="policyName",
        value="value"
    ),
    multi_az_rpo=resiliencehubv2.CfnService.TargetSourceProperty(
        policy_name="policyName",
        value=123
    ),
    multi_az_rto=resiliencehubv2.CfnService.TargetSourceProperty(
        policy_name="policyName",
        value=123
    ),
    multi_region_dr_approach=resiliencehubv2.CfnService.DisasterRecoverySourceProperty(
        policy_name="policyName",
        value="value"
    ),
    multi_region_rpo=resiliencehubv2.CfnService.TargetSourceProperty(
        policy_name="policyName",
        value=123
    ),
    multi_region_rto=resiliencehubv2.CfnService.TargetSourceProperty(
        policy_name="policyName",
        value=123
    )
)

Attributes

availability_slo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-availabilityslo

Type:

see

multi_az_dr_approach

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazdrapproach

Type:

see

multi_az_rpo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazrpo

Type:

see

multi_az_rto

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazrto

Type:

see

multi_region_dr_approach

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregiondrapproach

Type:

see

multi_region_rpo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregionrpo

Type:

see

multi_region_rto

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregionrto

Type:

see

EksSourceProperty

class CfnService.EksSourceProperty(*, cluster_arn, namespaces)

Bases: object

Parameters:

• cluster_arn (str) – ARN of the EKS cluster.

• namespaces (Sequence[str]) – EKS namespaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-ekssource.html

ExampleMetadata:

fixture=_generated

Example:

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

eks_source_property = resiliencehubv2.CfnService.EksSourceProperty(
    cluster_arn="clusterArn",
    namespaces=["namespaces"]
)

Attributes

cluster_arn

ARN of the EKS cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-ekssource.html#cfn-resiliencehubv2-service-ekssource-clusterarn

namespaces

EKS namespaces.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-ekssource.html#cfn-resiliencehubv2-service-ekssource-namespaces

InputSourceDefinitionProperty

class CfnService.InputSourceDefinitionProperty(*, resource_configuration)

Bases: object

An input source for the service.

Parameters:

resource_configuration (Union[IResolvable, ResourceConfigurationProperty, Dict[str, Any]]) – Resource configuration for an input source. Provide exactly one field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-inputsourcedefinition.html

ExampleMetadata:

fixture=_generated

Example:

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

input_source_definition_property = resiliencehubv2.CfnService.InputSourceDefinitionProperty(
    resource_configuration=resiliencehubv2.CfnService.ResourceConfigurationProperty(
        cfn_stack_arn="cfnStackArn",
        design_file_s3_url="designFileS3Url",
        eks=resiliencehubv2.CfnService.EksSourceProperty(
            cluster_arn="clusterArn",
            namespaces=["namespaces"]
        ),
        resource_tags=[resiliencehubv2.CfnService.ResourceTagProperty(
            key="key",
            values=["values"]
        )],
        tf_state_file_url="tfStateFileUrl"
    )
)

Attributes

resource_configuration

Resource configuration for an input source.

Provide exactly one field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-inputsourcedefinition.html#cfn-resiliencehubv2-service-inputsourcedefinition-resourceconfiguration

PermissionModelProperty

class CfnService.PermissionModelProperty(*, invoker_role_name, cross_account_role_arns=None)

Bases: object

Parameters:

• invoker_role_name (str) – Name of the invoker IAM role.

• cross_account_role_arns (Union[IResolvable, Sequence[Union[IResolvable, CrossAccountRoleConfigurationProperty, Dict[str, Any]]], None]) – Cross-account role ARNs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-permissionmodel.html

ExampleMetadata:

fixture=_generated

Example:

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

permission_model_property = resiliencehubv2.CfnService.PermissionModelProperty(
    invoker_role_name="invokerRoleName",

    # the properties below are optional
    cross_account_role_arns=[resiliencehubv2.CfnService.CrossAccountRoleConfigurationProperty(
        cross_account_role_arn="crossAccountRoleArn",

        # the properties below are optional
        external_id="externalId"
    )]
)

Attributes

cross_account_role_arns

Cross-account role ARNs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-permissionmodel.html#cfn-resiliencehubv2-service-permissionmodel-crossaccountrolearns

invoker_role_name

Name of the invoker IAM role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-permissionmodel.html#cfn-resiliencehubv2-service-permissionmodel-invokerrolename

ReportOutputConfigurationProperty

class CfnService.ReportOutputConfigurationProperty(*, s3)

Bases: object

Configuration for a report output destination.

Parameters:

s3 (Union[IResolvable, S3ReportOutputConfigurationProperty, Dict[str, Any]]) – S3 configuration for report output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-reportoutputconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

report_output_configuration_property = resiliencehubv2.CfnService.ReportOutputConfigurationProperty(
    s3=resiliencehubv2.CfnService.S3ReportOutputConfigurationProperty(
        bucket_owner="bucketOwner",
        bucket_path="bucketPath"
    )
)

Attributes

s3

S3 configuration for report output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-reportoutputconfiguration.html#cfn-resiliencehubv2-service-reportoutputconfiguration-s3

ResourceConfigurationProperty

class CfnService.ResourceConfigurationProperty(*, cfn_stack_arn=None, design_file_s3_url=None, eks=None, resource_tags=None, tf_state_file_url=None)

Bases: object

Resource configuration for an input source.

Provide exactly one field.

Parameters:

• cfn_stack_arn (Optional[str]) – ARN of a CloudFormation stack.

• design_file_s3_url (Optional[str]) – S3 URL of a design file.

• eks (Union[IResolvable, EksSourceProperty, Dict[str, Any], None])

• resource_tags (Union[IResolvable, Sequence[Union[IResolvable, ResourceTagProperty, Dict[str, Any]]], None]) – Resource tags to discover resources.

• tf_state_file_url (Optional[str]) – URL of a Terraform state file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

resource_configuration_property = resiliencehubv2.CfnService.ResourceConfigurationProperty(
    cfn_stack_arn="cfnStackArn",
    design_file_s3_url="designFileS3Url",
    eks=resiliencehubv2.CfnService.EksSourceProperty(
        cluster_arn="clusterArn",
        namespaces=["namespaces"]
    ),
    resource_tags=[resiliencehubv2.CfnService.ResourceTagProperty(
        key="key",
        values=["values"]
    )],
    tf_state_file_url="tfStateFileUrl"
)

Attributes

cfn_stack_arn

ARN of a CloudFormation stack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-cfnstackarn

design_file_s3_url

S3 URL of a design file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-designfiles3url

eks

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-eks

Type:

see

resource_tags

Resource tags to discover resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-resourcetags

tf_state_file_url

URL of a Terraform state file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-tfstatefileurl

ResourceTagProperty

class CfnService.ResourceTagProperty(*, key, values)

Bases: object

Parameters:

• key (str) – Tag key.

• values (Sequence[str]) – Tag values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html

ExampleMetadata:

fixture=_generated

Example:

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

resource_tag_property = resiliencehubv2.CfnService.ResourceTagProperty(
    key="key",
    values=["values"]
)

Attributes

key

Tag key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html#cfn-resiliencehubv2-service-resourcetag-key

values

Tag values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html#cfn-resiliencehubv2-service-resourcetag-values

S3ReportOutputConfigurationProperty

class CfnService.S3ReportOutputConfigurationProperty(*, bucket_owner, bucket_path)

Bases: object

S3 configuration for report output.

Parameters:

• bucket_owner (str) – Account ID of the bucket owner.

• bucket_path (str) – S3 bucket path where reports will be written.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-s3reportoutputconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

s3_report_output_configuration_property = resiliencehubv2.CfnService.S3ReportOutputConfigurationProperty(
    bucket_owner="bucketOwner",
    bucket_path="bucketPath"
)

Attributes

bucket_owner

Account ID of the bucket owner.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-s3reportoutputconfiguration.html#cfn-resiliencehubv2-service-s3reportoutputconfiguration-bucketowner

bucket_path

S3 bucket path where reports will be written.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-s3reportoutputconfiguration.html#cfn-resiliencehubv2-service-s3reportoutputconfiguration-bucketpath

ServiceReportConfigurationProperty

class CfnService.ServiceReportConfigurationProperty(*, report_output)

Bases: object

Configuration for automatic report generation on a Service.

Parameters:

report_output (Union[IResolvable, Sequence[Union[IResolvable, ReportOutputConfigurationProperty, Dict[str, Any]]]]) – Output destinations for generated reports.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-servicereportconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

service_report_configuration_property = resiliencehubv2.CfnService.ServiceReportConfigurationProperty(
    report_output=[resiliencehubv2.CfnService.ReportOutputConfigurationProperty(
        s3=resiliencehubv2.CfnService.S3ReportOutputConfigurationProperty(
            bucket_owner="bucketOwner",
            bucket_path="bucketPath"
        )
    )]
)

Attributes

report_output

Output destinations for generated reports.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-servicereportconfiguration.html#cfn-resiliencehubv2-service-servicereportconfiguration-reportoutput

SloSourceProperty

class CfnService.SloSourceProperty(*, policy_name=None, value=None)

Bases: object

Parameters:

• policy_name (Optional[str])

• value (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html

ExampleMetadata:

fixture=_generated

Example:

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

slo_source_property = resiliencehubv2.CfnService.SloSourceProperty(
    policy_name="policyName",
    value=123
)

Attributes

policy_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html#cfn-resiliencehubv2-service-slosource-policyname

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html#cfn-resiliencehubv2-service-slosource-value

Type:

see

TargetSourceProperty

class CfnService.TargetSourceProperty(*, policy_name=None, value=None)

Bases: object

Parameters:

• policy_name (Optional[str])

• value (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html

ExampleMetadata:

fixture=_generated

Example:

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

target_source_property = resiliencehubv2.CfnService.TargetSourceProperty(
    policy_name="policyName",
    value=123
)

Attributes

policy_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html#cfn-resiliencehubv2-service-targetsource-policyname

Type:

see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html#cfn-resiliencehubv2-service-targetsource-value

Type:

see