CfnServicePropsMixin
- class aws_cdk.cfn_property_mixins.aws_resiliencehubv2.CfnServicePropsMixin(props, *, strategy=None)
Bases:
MixinCreates a resilience-managed service with associated systems, input sources, assertions, and service functions.
- See:
- CloudformationResource:
AWS::ResilienceHubV2::Service
- Mixin:
true
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_service_props_mixin = resiliencehubv2.CfnServicePropsMixin(resiliencehubv2.CfnServiceMixinProps( assertions=[resiliencehubv2.CfnServicePropsMixin.AssertionDefinitionProperty( text="text" )], associated_systems=[resiliencehubv2.CfnServicePropsMixin.AssociatedSystemProperty( system_arn="systemArn", user_journey_ids=["userJourneyIds"] )], dependency_discovery="dependencyDiscovery", description="description", input_sources=[resiliencehubv2.CfnServicePropsMixin.InputSourceDefinitionProperty( resource_configuration=resiliencehubv2.CfnServicePropsMixin.ResourceConfigurationProperty( cfn_stack_arn="cfnStackArn", design_file_s3_url="designFileS3Url", eks=resiliencehubv2.CfnServicePropsMixin.EksSourceProperty( cluster_arn="clusterArn", namespaces=["namespaces"] ), resource_tags=[resiliencehubv2.CfnServicePropsMixin.ResourceTagProperty( key="key", values=["values"] )], tf_state_file_url="tfStateFileUrl" ) )], kms_key_id="kmsKeyId", name="name", permission_model=resiliencehubv2.CfnServicePropsMixin.PermissionModelProperty( cross_account_role_arns=[resiliencehubv2.CfnServicePropsMixin.CrossAccountRoleConfigurationProperty( cross_account_role_arn="crossAccountRoleArn", external_id="externalId" )], invoker_role_name="invokerRoleName" ), policy_arn="policyArn", regions=["regions"], report_configuration=resiliencehubv2.CfnServicePropsMixin.ServiceReportConfigurationProperty( report_output=[resiliencehubv2.CfnServicePropsMixin.ReportOutputConfigurationProperty( s3=resiliencehubv2.CfnServicePropsMixin.S3ReportOutputConfigurationProperty( bucket_owner="bucketOwner", bucket_path="bucketPath" ) )] ), tags=[cdk.CfnTag( key="key", value="value" )] ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::ResilienceHubV2::Service.- Parameters:
props (
Union[CfnServiceMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['assertions', 'associatedSystems', 'dependencyDiscovery', 'description', 'inputSources', 'kmsKeyId', 'name', 'permissionModel', 'policyArn', 'regions', 'reportConfiguration', 'tags']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
AssertionDefinitionProperty
- class CfnServicePropsMixin.AssertionDefinitionProperty(*, text=None)
Bases:
objectAn assertion about the service’s resilience posture.
- Parameters:
text (
Optional[str]) – The text of the assertion.- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 assertion_definition_property = resiliencehubv2.CfnServicePropsMixin.AssertionDefinitionProperty( text="text" )
Attributes
AssociatedSystemProperty
- class CfnServicePropsMixin.AssociatedSystemProperty(*, system_arn=None, user_journey_ids=None)
Bases:
object- Parameters:
system_arn (
Optional[str]) – The system ARN.user_journey_ids (
Optional[Sequence[str]]) – User journey IDs associated with this system.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 associated_system_property = resiliencehubv2.CfnServicePropsMixin.AssociatedSystemProperty( system_arn="systemArn", user_journey_ids=["userJourneyIds"] )
Attributes
- system_arn
The system ARN.
- user_journey_ids
User journey IDs associated with this system.
CrossAccountRoleConfigurationProperty
- class CfnServicePropsMixin.CrossAccountRoleConfigurationProperty(*, cross_account_role_arn=None, external_id=None)
Bases:
object- Parameters:
cross_account_role_arn (
Optional[str]) – ARN of the cross-account IAM role.external_id (
Optional[str]) – External ID for cross-account access.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 cross_account_role_configuration_property = resiliencehubv2.CfnServicePropsMixin.CrossAccountRoleConfigurationProperty( cross_account_role_arn="crossAccountRoleArn", external_id="externalId" )
Attributes
- cross_account_role_arn
ARN of the cross-account IAM role.
- external_id
External ID for cross-account access.
DisasterRecoverySourceProperty
- class CfnServicePropsMixin.DisasterRecoverySourceProperty(*, policy_name=None, value=None)
Bases:
object- Parameters:
policy_name (
Optional[str])value (
Optional[str])
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 disaster_recovery_source_property = resiliencehubv2.CfnServicePropsMixin.DisasterRecoverySourceProperty( policy_name="policyName", value="value" )
Attributes
- policy_name
-
- Type:
see
EffectivePolicyValuesProperty
- class CfnServicePropsMixin.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:
objectEffective 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:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 effective_policy_values_property = resiliencehubv2.CfnServicePropsMixin.EffectivePolicyValuesProperty( availability_slo=resiliencehubv2.CfnServicePropsMixin.SloSourceProperty( policy_name="policyName", value=123 ), multi_az_dr_approach=resiliencehubv2.CfnServicePropsMixin.DisasterRecoverySourceProperty( policy_name="policyName", value="value" ), multi_az_rpo=resiliencehubv2.CfnServicePropsMixin.TargetSourceProperty( policy_name="policyName", value=123 ), multi_az_rto=resiliencehubv2.CfnServicePropsMixin.TargetSourceProperty( policy_name="policyName", value=123 ), multi_region_dr_approach=resiliencehubv2.CfnServicePropsMixin.DisasterRecoverySourceProperty( policy_name="policyName", value="value" ), multi_region_rpo=resiliencehubv2.CfnServicePropsMixin.TargetSourceProperty( policy_name="policyName", value=123 ), multi_region_rto=resiliencehubv2.CfnServicePropsMixin.TargetSourceProperty( policy_name="policyName", value=123 ) )
Attributes
- availability_slo
-
- Type:
see
- multi_az_dr_approach
-
- Type:
see
- multi_az_rpo
-
- Type:
see
- multi_az_rto
-
- Type:
see
- multi_region_dr_approach
-
- Type:
see
- multi_region_rpo
-
- Type:
see
EksSourceProperty
- class CfnServicePropsMixin.EksSourceProperty(*, cluster_arn=None, namespaces=None)
Bases:
object- Parameters:
cluster_arn (
Optional[str]) – ARN of the EKS cluster.namespaces (
Optional[Sequence[str]]) – EKS namespaces.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 eks_source_property = resiliencehubv2.CfnServicePropsMixin.EksSourceProperty( cluster_arn="clusterArn", namespaces=["namespaces"] )
Attributes
- cluster_arn
ARN of the EKS cluster.
InputSourceDefinitionProperty
- class CfnServicePropsMixin.InputSourceDefinitionProperty(*, resource_configuration=None)
Bases:
objectAn input source for the service.
- Parameters:
resource_configuration (
Union[IResolvable,ResourceConfigurationProperty,Dict[str,Any],None]) – Resource configuration for an input source. Provide exactly one field.- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 input_source_definition_property = resiliencehubv2.CfnServicePropsMixin.InputSourceDefinitionProperty( resource_configuration=resiliencehubv2.CfnServicePropsMixin.ResourceConfigurationProperty( cfn_stack_arn="cfnStackArn", design_file_s3_url="designFileS3Url", eks=resiliencehubv2.CfnServicePropsMixin.EksSourceProperty( cluster_arn="clusterArn", namespaces=["namespaces"] ), resource_tags=[resiliencehubv2.CfnServicePropsMixin.ResourceTagProperty( key="key", values=["values"] )], tf_state_file_url="tfStateFileUrl" ) )
Attributes
- resource_configuration
Resource configuration for an input source.
Provide exactly one field.
PermissionModelProperty
- class CfnServicePropsMixin.PermissionModelProperty(*, cross_account_role_arns=None, invoker_role_name=None)
Bases:
object- Parameters:
cross_account_role_arns (
Union[IResolvable,Sequence[Union[IResolvable,CrossAccountRoleConfigurationProperty,Dict[str,Any]]],None]) – Cross-account role ARNs.invoker_role_name (
Optional[str]) – Name of the invoker IAM role.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 permission_model_property = resiliencehubv2.CfnServicePropsMixin.PermissionModelProperty( cross_account_role_arns=[resiliencehubv2.CfnServicePropsMixin.CrossAccountRoleConfigurationProperty( cross_account_role_arn="crossAccountRoleArn", external_id="externalId" )], invoker_role_name="invokerRoleName" )
Attributes
- cross_account_role_arns
Cross-account role ARNs.
- invoker_role_name
Name of the invoker IAM role.
ReportOutputConfigurationProperty
- class CfnServicePropsMixin.ReportOutputConfigurationProperty(*, s3=None)
Bases:
objectConfiguration for a report output destination.
- Parameters:
s3 (
Union[IResolvable,S3ReportOutputConfigurationProperty,Dict[str,Any],None]) – S3 configuration for report output.- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 report_output_configuration_property = resiliencehubv2.CfnServicePropsMixin.ReportOutputConfigurationProperty( s3=resiliencehubv2.CfnServicePropsMixin.S3ReportOutputConfigurationProperty( bucket_owner="bucketOwner", bucket_path="bucketPath" ) )
Attributes
ResourceConfigurationProperty
- class CfnServicePropsMixin.ResourceConfigurationProperty(*, cfn_stack_arn=None, design_file_s3_url=None, eks=None, resource_tags=None, tf_state_file_url=None)
Bases:
objectResource 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:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 resource_configuration_property = resiliencehubv2.CfnServicePropsMixin.ResourceConfigurationProperty( cfn_stack_arn="cfnStackArn", design_file_s3_url="designFileS3Url", eks=resiliencehubv2.CfnServicePropsMixin.EksSourceProperty( cluster_arn="clusterArn", namespaces=["namespaces"] ), resource_tags=[resiliencehubv2.CfnServicePropsMixin.ResourceTagProperty( key="key", values=["values"] )], tf_state_file_url="tfStateFileUrl" )
Attributes
- cfn_stack_arn
ARN of a CloudFormation stack.
- design_file_s3_url
S3 URL of a design file.
- eks
-
- Type:
see
- resource_tags
Resource tags to discover resources.
- tf_state_file_url
URL of a Terraform state file.
ResourceTagProperty
- class CfnServicePropsMixin.ResourceTagProperty(*, key=None, values=None)
Bases:
object- Parameters:
key (
Optional[str]) – Tag key.values (
Optional[Sequence[str]]) – Tag values.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 resource_tag_property = resiliencehubv2.CfnServicePropsMixin.ResourceTagProperty( key="key", values=["values"] )
Attributes
- key
Tag key.
S3ReportOutputConfigurationProperty
- class CfnServicePropsMixin.S3ReportOutputConfigurationProperty(*, bucket_owner=None, bucket_path=None)
Bases:
objectS3 configuration for report output.
- Parameters:
bucket_owner (
Optional[str]) – Account ID of the bucket owner.bucket_path (
Optional[str]) – S3 bucket path where reports will be written.
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 s3_report_output_configuration_property = resiliencehubv2.CfnServicePropsMixin.S3ReportOutputConfigurationProperty( bucket_owner="bucketOwner", bucket_path="bucketPath" )
Attributes
- bucket_owner
Account ID of the bucket owner.
- bucket_path
S3 bucket path where reports will be written.
ServiceReportConfigurationProperty
- class CfnServicePropsMixin.ServiceReportConfigurationProperty(*, report_output=None)
Bases:
objectConfiguration for automatic report generation on a Service.
- Parameters:
report_output (
Union[IResolvable,Sequence[Union[IResolvable,ReportOutputConfigurationProperty,Dict[str,Any]]],None]) – Output destinations for generated reports.- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 service_report_configuration_property = resiliencehubv2.CfnServicePropsMixin.ServiceReportConfigurationProperty( report_output=[resiliencehubv2.CfnServicePropsMixin.ReportOutputConfigurationProperty( s3=resiliencehubv2.CfnServicePropsMixin.S3ReportOutputConfigurationProperty( bucket_owner="bucketOwner", bucket_path="bucketPath" ) )] )
Attributes
- report_output
Output destinations for generated reports.
SloSourceProperty
- class CfnServicePropsMixin.SloSourceProperty(*, policy_name=None, value=None)
Bases:
object- Parameters:
policy_name (
Optional[str])value (
Union[int,float,None])
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 slo_source_property = resiliencehubv2.CfnServicePropsMixin.SloSourceProperty( policy_name="policyName", value=123 )
Attributes
- policy_name
-
- Type:
see
TargetSourceProperty
- class CfnServicePropsMixin.TargetSourceProperty(*, policy_name=None, value=None)
Bases:
object- Parameters:
policy_name (
Optional[str])value (
Union[int,float,None])
- See:
- 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.cfn_property_mixins import aws_resiliencehubv2 as resiliencehubv2 target_source_property = resiliencehubv2.CfnServicePropsMixin.TargetSourceProperty( policy_name="policyName", value=123 )
Attributes
- policy_name
-
- Type:
see