aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,275 lines • 51.7 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { IPolicyRef, IServiceFunctionRef, IServiceRef, ISystemRef, IUserJourneyRef, PolicyReference, ServiceFunctionReference, ServiceReference, SystemReference, UserJourneyReference } from "../../interfaces/generated/aws-resiliencehubv2-interfaces.generated";
/**
* Creates a resilience policy that defines availability and disaster recovery requirements.
*
* @cloudformationResource AWS::ResilienceHubV2::Policy
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html
*/
export declare class CfnPolicy extends cdk.CfnResource implements cdk.IInspectable, IPolicyRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnPolicy from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPolicy;
/**
* Checks whether the given object is a CfnPolicy
*/
static isCfnPolicy(x: any): x is CfnPolicy;
static arnForPolicy(resource: IPolicyRef): string;
private _availabilitySlo?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
private _dataRecovery?;
/**
* The description of the policy.
*/
private _description?;
/**
* The KMS key ID for encrypting policy data.
*/
private _kmsKeyId?;
private _multiAz?;
private _multiRegion?;
/**
* The name of the policy.
*/
private _name;
/**
* Tags assigned to the policy.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::ResilienceHubV2::Policy`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnPolicyProps);
get policyRef(): PolicyReference;
get availabilitySlo(): CfnPolicy.AvailabilitySloProperty | cdk.IResolvable | undefined;
set availabilitySlo(value: CfnPolicy.AvailabilitySloProperty | cdk.IResolvable | undefined);
get dataRecovery(): CfnPolicy.DataRecoveryTargetsProperty | cdk.IResolvable | undefined;
set dataRecovery(value: CfnPolicy.DataRecoveryTargetsProperty | cdk.IResolvable | undefined);
/**
* The description of the policy.
*/
get description(): string | undefined;
/**
* The description of the policy.
*/
set description(value: string | undefined);
/**
* The KMS key ID for encrypting policy data.
*/
get kmsKeyId(): string | undefined;
/**
* The KMS key ID for encrypting policy data.
*/
set kmsKeyId(value: string | undefined);
get multiAz(): cdk.IResolvable | CfnPolicy.MultiAzTargetsProperty | undefined;
set multiAz(value: cdk.IResolvable | CfnPolicy.MultiAzTargetsProperty | undefined);
get multiRegion(): cdk.IResolvable | CfnPolicy.MultiRegionTargetsProperty | undefined;
set multiRegion(value: cdk.IResolvable | CfnPolicy.MultiRegionTargetsProperty | undefined);
/**
* The name of the policy.
*/
get name(): string;
/**
* The name of the policy.
*/
set name(value: string);
/**
* Tags assigned to the policy.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* Tags assigned to the policy.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The number of services associated with this policy.
*
* @cloudformationAttribute AssociatedServiceCount
*/
get attrAssociatedServiceCount(): number;
/**
* The timestamp when the policy was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The ARN of the policy.
*
* @cloudformationAttribute PolicyArn
*/
get attrPolicyArn(): string;
/**
* The timestamp when the policy was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnPolicy {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-availabilityslo.html
*/
interface AvailabilitySloProperty {
/**
* Availability target percentage.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-availabilityslo.html#cfn-resiliencehubv2-policy-availabilityslo-target
*/
readonly target?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiaztargets.html
*/
interface MultiAzTargetsProperty {
/**
* Multi-AZ disaster recovery approach.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiaztargets.html#cfn-resiliencehubv2-policy-multiaztargets-disasterrecoveryapproach
*/
readonly disasterRecoveryApproach?: string;
/**
* Recovery Point Objective in minutes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiaztargets.html#cfn-resiliencehubv2-policy-multiaztargets-rpoinminutes
*/
readonly rpoInMinutes?: number;
/**
* Recovery Time Objective in minutes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiaztargets.html#cfn-resiliencehubv2-policy-multiaztargets-rtoinminutes
*/
readonly rtoInMinutes?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiregiontargets.html
*/
interface MultiRegionTargetsProperty {
/**
* Multi-Region disaster recovery approach.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiregiontargets.html#cfn-resiliencehubv2-policy-multiregiontargets-disasterrecoveryapproach
*/
readonly disasterRecoveryApproach?: string;
/**
* Recovery Point Objective in minutes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiregiontargets.html#cfn-resiliencehubv2-policy-multiregiontargets-rpoinminutes
*/
readonly rpoInMinutes?: number;
/**
* Recovery Time Objective in minutes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-multiregiontargets.html#cfn-resiliencehubv2-policy-multiregiontargets-rtoinminutes
*/
readonly rtoInMinutes?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-datarecoverytargets.html
*/
interface DataRecoveryTargetsProperty {
/**
* Time between backups in minutes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-policy-datarecoverytargets.html#cfn-resiliencehubv2-policy-datarecoverytargets-timebetweenbackupsinminutes
*/
readonly timeBetweenBackupsInMinutes?: number;
}
}
/**
* Properties for defining a `CfnPolicy`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html
*/
export interface CfnPolicyProps {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-availabilityslo
*/
readonly availabilitySlo?: CfnPolicy.AvailabilitySloProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-datarecovery
*/
readonly dataRecovery?: CfnPolicy.DataRecoveryTargetsProperty | cdk.IResolvable;
/**
* The description of the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-description
*/
readonly description?: string;
/**
* The KMS key ID for encrypting policy data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-multiaz
*/
readonly multiAz?: cdk.IResolvable | CfnPolicy.MultiAzTargetsProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-multiregion
*/
readonly multiRegion?: cdk.IResolvable | CfnPolicy.MultiRegionTargetsProperty;
/**
* The name of the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-name
*/
readonly name: string;
/**
* Tags assigned to the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-policy.html#cfn-resiliencehubv2-policy-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates a resilience-managed service with associated systems, input sources, assertions, and service functions.
*
* @cloudformationResource AWS::ResilienceHubV2::Service
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html
*/
export declare class CfnService extends cdk.CfnResource implements cdk.IInspectable, IServiceRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnService from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnService;
/**
* Checks whether the given object is a CfnService
*/
static isCfnService(x: any): x is CfnService;
static arnForService(resource: IServiceRef): string;
/**
* Assertions associated with this service.
*/
private _assertions?;
/**
* Systems associated with this service.
*/
private _associatedSystems?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* Dependency discovery state.
*/
private _dependencyDiscovery?;
/**
* The description of the service.
*/
private _description?;
/**
* Input sources for this service.
*/
private _inputSources?;
/**
* The KMS key ID for encrypting service data.
*/
private _kmsKeyId?;
/**
* The name of the service.
*/
private _name;
private _permissionModel?;
/**
* The ARN of the resilience policy to associate.
*/
private _policyArn?;
/**
* AWS regions for the service.
*/
private _regions;
/**
* Configuration for automatic report generation on a Service.
*/
private _reportConfiguration?;
/**
* Tags assigned to the service.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::ResilienceHubV2::Service`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnServiceProps);
get serviceRef(): ServiceReference;
/**
* Assertions associated with this service.
*/
get assertions(): Array<CfnService.AssertionDefinitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* Assertions associated with this service.
*/
set assertions(value: Array<CfnService.AssertionDefinitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* Systems associated with this service.
*/
get associatedSystems(): Array<CfnService.AssociatedSystemProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* Systems associated with this service.
*/
set associatedSystems(value: Array<CfnService.AssociatedSystemProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* Dependency discovery state.
*/
get dependencyDiscovery(): string | undefined;
/**
* Dependency discovery state.
*/
set dependencyDiscovery(value: string | undefined);
/**
* The description of the service.
*/
get description(): string | undefined;
/**
* The description of the service.
*/
set description(value: string | undefined);
/**
* Input sources for this service.
*/
get inputSources(): Array<CfnService.InputSourceDefinitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* Input sources for this service.
*/
set inputSources(value: Array<CfnService.InputSourceDefinitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* The KMS key ID for encrypting service data.
*/
get kmsKeyId(): string | undefined;
/**
* The KMS key ID for encrypting service data.
*/
set kmsKeyId(value: string | undefined);
/**
* The name of the service.
*/
get name(): string;
/**
* The name of the service.
*/
set name(value: string);
get permissionModel(): cdk.IResolvable | CfnService.PermissionModelProperty | undefined;
set permissionModel(value: cdk.IResolvable | CfnService.PermissionModelProperty | undefined);
/**
* The ARN of the resilience policy to associate.
*/
get policyArn(): string | undefined;
/**
* The ARN of the resilience policy to associate.
*/
set policyArn(value: string | undefined);
/**
* AWS regions for the service.
*/
get regions(): Array<string>;
/**
* AWS regions for the service.
*/
set regions(value: Array<string>);
/**
* Configuration for automatic report generation on a Service.
*/
get reportConfiguration(): cdk.IResolvable | CfnService.ServiceReportConfigurationProperty | undefined;
/**
* Configuration for automatic report generation on a Service.
*/
set reportConfiguration(value: cdk.IResolvable | CfnService.ServiceReportConfigurationProperty | undefined);
/**
* Tags assigned to the service.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* Tags assigned to the service.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp when the service was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* Effective policy values computed from the associated policy.
*
* @cloudformationAttribute EffectivePolicyValues
*/
get attrEffectivePolicyValues(): cdk.IResolvable;
/**
* The ARN of the service.
*
* @cloudformationAttribute ServiceArn
*/
get attrServiceArn(): string;
/**
* The timestamp when the service was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnService {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-associatedsystem.html
*/
interface AssociatedSystemProperty {
/**
* The system ARN.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-associatedsystem.html#cfn-resiliencehubv2-service-associatedsystem-systemarn
*/
readonly systemArn: string;
/**
* 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
*/
readonly userJourneyIds?: Array<string>;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-permissionmodel.html
*/
interface PermissionModelProperty {
/**
* Cross-account role ARNs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-permissionmodel.html#cfn-resiliencehubv2-service-permissionmodel-crossaccountrolearns
*/
readonly crossAccountRoleArns?: Array<CfnService.CrossAccountRoleConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* 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
*/
readonly invokerRoleName: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-crossaccountroleconfiguration.html
*/
interface CrossAccountRoleConfigurationProperty {
/**
* 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
*/
readonly crossAccountRoleArn: string;
/**
* 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
*/
readonly externalId?: string;
}
/**
* Configuration for automatic report generation on a Service.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-servicereportconfiguration.html
*/
interface ServiceReportConfigurationProperty {
/**
* 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
*/
readonly reportOutput: Array<cdk.IResolvable | CfnService.ReportOutputConfigurationProperty> | cdk.IResolvable;
}
/**
* Configuration for a report output destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-reportoutputconfiguration.html
*/
interface ReportOutputConfigurationProperty {
/**
* 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
*/
readonly s3: cdk.IResolvable | CfnService.S3ReportOutputConfigurationProperty;
}
/**
* S3 configuration for report output.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-s3reportoutputconfiguration.html
*/
interface S3ReportOutputConfigurationProperty {
/**
* 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
*/
readonly bucketOwner: string;
/**
* 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
*/
readonly bucketPath: string;
}
/**
* An input source for the service.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-inputsourcedefinition.html
*/
interface InputSourceDefinitionProperty {
/**
* 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
*/
readonly resourceConfiguration: cdk.IResolvable | CfnService.ResourceConfigurationProperty;
}
/**
* Resource configuration for an input source.
*
* Provide exactly one field.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html
*/
interface ResourceConfigurationProperty {
/**
* 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
*/
readonly cfnStackArn?: string;
/**
* 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
*/
readonly designFileS3Url?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourceconfiguration.html#cfn-resiliencehubv2-service-resourceconfiguration-eks
*/
readonly eks?: CfnService.EksSourceProperty | cdk.IResolvable;
/**
* 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
*/
readonly resourceTags?: Array<cdk.IResolvable | CfnService.ResourceTagProperty> | cdk.IResolvable;
/**
* 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
*/
readonly tfStateFileUrl?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html
*/
interface ResourceTagProperty {
/**
* Tag key.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html#cfn-resiliencehubv2-service-resourcetag-key
*/
readonly key: string;
/**
* Tag values.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-resourcetag.html#cfn-resiliencehubv2-service-resourcetag-values
*/
readonly values: Array<string>;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-ekssource.html
*/
interface EksSourceProperty {
/**
* 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
*/
readonly clusterArn: string;
/**
* EKS namespaces.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-ekssource.html#cfn-resiliencehubv2-service-ekssource-namespaces
*/
readonly namespaces: Array<string>;
}
/**
* An assertion about the service's resilience posture.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-assertiondefinition.html
*/
interface AssertionDefinitionProperty {
/**
* 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
*/
readonly text: string;
}
/**
* Effective policy values computed from the associated policy.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html
*/
interface EffectivePolicyValuesProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-availabilityslo
*/
readonly availabilitySlo?: cdk.IResolvable | CfnService.SloSourceProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazdrapproach
*/
readonly multiAzDrApproach?: CfnService.DisasterRecoverySourceProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazrpo
*/
readonly multiAzRpo?: cdk.IResolvable | CfnService.TargetSourceProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiazrto
*/
readonly multiAzRto?: cdk.IResolvable | CfnService.TargetSourceProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregiondrapproach
*/
readonly multiRegionDrApproach?: CfnService.DisasterRecoverySourceProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregionrpo
*/
readonly multiRegionRpo?: cdk.IResolvable | CfnService.TargetSourceProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-effectivepolicyvalues.html#cfn-resiliencehubv2-service-effectivepolicyvalues-multiregionrto
*/
readonly multiRegionRto?: cdk.IResolvable | CfnService.TargetSourceProperty;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html
*/
interface SloSourceProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html#cfn-resiliencehubv2-service-slosource-policyname
*/
readonly policyName?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-slosource.html#cfn-resiliencehubv2-service-slosource-value
*/
readonly value?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html
*/
interface TargetSourceProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html#cfn-resiliencehubv2-service-targetsource-policyname
*/
readonly policyName?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-targetsource.html#cfn-resiliencehubv2-service-targetsource-value
*/
readonly value?: number;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html
*/
interface DisasterRecoverySourceProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html#cfn-resiliencehubv2-service-disasterrecoverysource-policyname
*/
readonly policyName?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehubv2-service-disasterrecoverysource.html#cfn-resiliencehubv2-service-disasterrecoverysource-value
*/
readonly value?: string;
}
}
/**
* Properties for defining a `CfnService`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html
*/
export interface CfnServiceProps {
/**
* Assertions associated with this service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-assertions
*/
readonly assertions?: Array<CfnService.AssertionDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Systems associated with this service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-associatedsystems
*/
readonly associatedSystems?: Array<CfnService.AssociatedSystemProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Dependency discovery state.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-dependencydiscovery
*/
readonly dependencyDiscovery?: string;
/**
* The description of the service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-description
*/
readonly description?: string;
/**
* Input sources for this service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-inputsources
*/
readonly inputSources?: Array<CfnService.InputSourceDefinitionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The KMS key ID for encrypting service data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* The name of the service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-name
*/
readonly name: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-permissionmodel
*/
readonly permissionModel?: cdk.IResolvable | CfnService.PermissionModelProperty;
/**
* The ARN of the resilience policy to associate.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-policyarn
*/
readonly policyArn?: string;
/**
* AWS regions for the service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-regions
*/
readonly regions: Array<string>;
/**
* Configuration for automatic report generation on a Service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-reportconfiguration
*/
readonly reportConfiguration?: cdk.IResolvable | CfnService.ServiceReportConfigurationProperty;
/**
* Tags assigned to the service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-service.html#cfn-resiliencehubv2-service-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates a service function within a Resilience Hub service.
*
* @cloudformationResource AWS::ResilienceHubV2::ServiceFunction
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html
*/
export declare class CfnServiceFunction extends cdk.CfnResource implements cdk.IInspectable, IServiceFunctionRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnServiceFunction from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnServiceFunction;
/**
* Checks whether the given object is a CfnServiceFunction
*/
static isCfnServiceFunction(x: any): x is CfnServiceFunction;
/**
* The criticality of the service function.
*/
private _criticality;
/**
* The description of the service function.
*/
private _description?;
/**
* The name of the service function.
*/
private _name;
/**
* The ARN of the parent service.
*/
private _serviceArn;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::ResilienceHubV2::ServiceFunction`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnServiceFunctionProps);
get serviceFunctionRef(): ServiceFunctionReference;
/**
* The criticality of the service function.
*/
get criticality(): string;
/**
* The criticality of the service function.
*/
set criticality(value: string);
/**
* The description of the service function.
*/
get description(): string | undefined;
/**
* The description of the service function.
*/
set description(value: string | undefined);
/**
* The name of the service function.
*/
get name(): string;
/**
* The name of the service function.
*/
set name(value: string);
/**
* The ARN of the parent service.
*/
get serviceArn(): string;
/**
* The ARN of the parent service.
*/
set serviceArn(value: string);
/**
* The timestamp when the service function was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The number of resources associated with this function.
*
* @cloudformationAttribute ResourceCount
*/
get attrResourceCount(): number;
/**
* The server-generated service function ID.
*
* @cloudformationAttribute ServiceFunctionId
*/
get attrServiceFunctionId(): string;
/**
* The source of the service function.
*
* @cloudformationAttribute Source
*/
get attrSource(): string;
/**
* The timestamp when the service function was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnServiceFunction`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html
*/
export interface CfnServiceFunctionProps {
/**
* The criticality of the service function.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html#cfn-resiliencehubv2-servicefunction-criticality
*/
readonly criticality: string;
/**
* The description of the service function.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html#cfn-resiliencehubv2-servicefunction-description
*/
readonly description?: string;
/**
* The name of the service function.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html#cfn-resiliencehubv2-servicefunction-name
*/
readonly name: string;
/**
* The ARN of the parent service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-servicefunction.html#cfn-resiliencehubv2-servicefunction-servicearn
*/
readonly serviceArn: string;
}
/**
* Creates a system that represents a logical grouping of services.
*
* @cloudformationResource AWS::ResilienceHubV2::System
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html
*/
export declare class CfnSystem extends cdk.CfnResource implements cdk.IInspectable, ISystemRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnSystem from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSystem;
/**
* Checks whether the given object is a CfnSystem
*/
static isCfnSystem(x: any): x is CfnSystem;
static arnForSystem(resource: ISystemRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the system.
*/
private _description?;
/**
* The KMS key ID for encrypting system data.
*/
private _kmsKeyId?;
/**
* The name of the system.
*/
private _name;
/**
* Tags assigned to the system.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::ResilienceHubV2::System`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnSystemProps);
get systemRef(): SystemReference;
/**
* The description of the system.
*/
get description(): string | undefined;
/**
* The description of the system.
*/
set description(value: string | undefined);
/**
* The KMS key ID for encrypting system data.
*/
get kmsKeyId(): string | undefined;
/**
* The KMS key ID for encrypting system data.
*/
set kmsKeyId(value: string | undefined);
/**
* The name of the system.
*/
get name(): string;
/**
* The name of the system.
*/
set name(value: string);
/**
* Tags assigned to the system.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* Tags assigned to the system.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The timestamp when the system was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The ARN of the system.
*
* @cloudformationAttribute SystemArn
*/
get attrSystemArn(): string;
/**
* The system ID.
*
* @cloudformationAttribute SystemId
*/
get attrSystemId(): string;
/**
* The timestamp when the system was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnSystem`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html
*/
export interface CfnSystemProps {
/**
* The description of the system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html#cfn-resiliencehubv2-system-description
*/
readonly description?: string;
/**
* The KMS key ID for encrypting system data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html#cfn-resiliencehubv2-system-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* The name of the system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html#cfn-resiliencehubv2-system-name
*/
readonly name: string;
/**
* Tags assigned to the system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-system.html#cfn-resiliencehubv2-system-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates a user journey within a Resilience Hub system.
*
* @cloudformationResource AWS::ResilienceHubV2::UserJourney
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehubv2-userjourney.html
*/
export declare class CfnUserJourney extends cdk.CfnResource implements cdk.IInspectable, IUserJourneyRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnUserJourney from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnUserJourney;
/**
* Checks whether the given object is a CfnUserJourney
*/
static isCfnUserJourney(x: any): x is CfnUserJourney;
/**
* The description of the user journey.
*/
private _description?;
/**
* The name of the user journey.
*/
private _name;
/**
* The ARN of the resilience policy to associate with this user journey.
*/
private _policyArn?;
/**
* The system ARN or system ID that owns this user journey.
*/
private _systemIdentifier;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::ResilienceHubV2::UserJourney`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnUserJourneyProps);
get userJourneyRef(): UserJourneyReference;
/**
* The description of the user journey.
*/
get description(): string | undefined;
/**
* The description of the user journey.
*/
set description(value: string | undefined);
/**
* The name of the user journey.
*/
get name(): string;
/**
* The name of the user journey.
*/
set name(value: string);
/**
* The ARN of the resilience policy to associate with this user journey.
*/
get policyArn(): string | undefined;
/**
* The ARN of the resilience policy to associate with this user journey.
*/
set policyArn(value: string | undefined);
/**
* The system ARN or system ID that owns this user journey.
*/
get systemIdentifier(): string;
/**
* The system ARN or system ID that owns this user journey.
*/
set systemIdentifier(value: string);
/**
* The timestamp when the user journey was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The timestamp when the user journey was last updated.
*
* @cloudformationAttribute UpdatedAt
*/
get attrUpdatedAt(): string;
/**
* The server-generated user journey ID.
*
* @cloudformationAttribute UserJourneyId
*/
get attrUserJourneyId(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected re