UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,287 lines 133 kB
import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AccessLogSubscriptionReference, AuthPolicyReference, DomainVerificationReference, IAccessLogSubscriptionRef, IAuthPolicyRef, IDomainVerificationRef, IListenerRef, IResourceConfigurationRef, IResourceGatewayRef, IResourcePolicyRef, IRuleRef, IServiceNetworkRef, IServiceNetworkResourceAssociationRef, IServiceNetworkServiceAssociationRef, IServiceNetworkVpcAssociationRef, IServiceRef, ITargetGroupRef, ListenerReference, ResourceConfigurationReference, ResourceGatewayReference, ResourcePolicyReference, RuleReference, ServiceNetworkReference, ServiceNetworkResourceAssociationReference, ServiceNetworkServiceAssociationReference, ServiceNetworkVpcAssociationReference, ServiceReference, TargetGroupReference } from "../../interfaces/generated/aws-vpclattice-interfaces.generated"; import { aws_ec2 as ec2Refs } from "../../interfaces"; /** * Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. * * The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see [Access logs](https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html) in the *Amazon VPC Lattice User Guide* . * * @cloudformationResource AWS::VpcLattice::AccessLogSubscription * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html */ export declare class CfnAccessLogSubscription extends cdk.CfnResource implements cdk.IInspectable, IAccessLogSubscriptionRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAccessLogSubscription 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): CfnAccessLogSubscription; /** * Checks whether the given object is a CfnAccessLogSubscription */ static isCfnAccessLogSubscription(x: any): x is CfnAccessLogSubscription; static arnForAccessLogSubscription(resource: IAccessLogSubscriptionRef): string; /** * The Amazon Resource Name (ARN) of the destination. */ private _destinationArn; /** * The ID or ARN of the service network or service. */ private _resourceIdentifier?; /** * Log type of the service network. */ private _serviceNetworkLogType?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags for the access log subscription. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::AccessLogSubscription`. * * @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: CfnAccessLogSubscriptionProps); get accessLogSubscriptionRef(): AccessLogSubscriptionReference; /** * The Amazon Resource Name (ARN) of the destination. */ get destinationArn(): string; /** * The Amazon Resource Name (ARN) of the destination. */ set destinationArn(value: string); /** * The ID or ARN of the service network or service. */ get resourceIdentifier(): string | undefined; /** * The ID or ARN of the service network or service. */ set resourceIdentifier(value: string | undefined); /** * Log type of the service network. */ get serviceNetworkLogType(): string | undefined; /** * Log type of the service network. */ set serviceNetworkLogType(value: string | undefined); /** * The tags for the access log subscription. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * The tags for the access log subscription. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The Amazon Resource Name (ARN) of the access log subscription. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The ID of the access log subscription. * * @cloudformationAttribute Id */ get attrId(): string; /** * The Amazon Resource Name (ARN) of the access log subscription. * * @cloudformationAttribute ResourceArn */ get attrResourceArn(): string; /** * The ID of the service network or service. * * @cloudformationAttribute ResourceId */ get attrResourceId(): 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 `CfnAccessLogSubscription` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html */ export interface CfnAccessLogSubscriptionProps { /** * The Amazon Resource Name (ARN) of the destination. * * The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-destinationarn */ readonly destinationArn: string; /** * The ID or ARN of the service network or service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-resourceidentifier */ readonly resourceIdentifier?: string; /** * Log type of the service network. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-servicenetworklogtype */ readonly serviceNetworkLogType?: string; /** * The tags for the access log subscription. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-accesslogsubscription.html#cfn-vpclattice-accesslogsubscription-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines. * * For more information, see [Auth policies](https://docs.aws.amazon.com/vpc-lattice/latest/ug/auth-policies.html) in the *Amazon VPC Lattice User Guide* . * * @cloudformationResource AWS::VpcLattice::AuthPolicy * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html */ export declare class CfnAuthPolicy extends cdk.CfnResource implements cdk.IInspectable, IAuthPolicyRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAuthPolicy 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): CfnAuthPolicy; /** * Checks whether the given object is a CfnAuthPolicy */ static isCfnAuthPolicy(x: any): x is CfnAuthPolicy; /** * The auth policy. */ private _policy; /** * The ID or ARN of the service network or service for which the policy is created. */ private _resourceIdentifier; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::AuthPolicy`. * * @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: CfnAuthPolicyProps); get authPolicyRef(): AuthPolicyReference; /** * The auth policy. */ get policy(): any | cdk.IResolvable; /** * The auth policy. */ set policy(value: any | cdk.IResolvable); /** * The ID or ARN of the service network or service for which the policy is created. */ get resourceIdentifier(): string; /** * The ID or ARN of the service network or service for which the policy is created. */ set resourceIdentifier(value: string); /** * The state of the auth policy. The auth policy is only active when the auth type is set to `AWS _IAM` . If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is `NONE` , then any auth policy you provide will remain inactive. * * @cloudformationAttribute State */ get attrState(): 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 `CfnAuthPolicy` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html */ export interface CfnAuthPolicyProps { /** * The auth policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html#cfn-vpclattice-authpolicy-policy */ readonly policy: any | cdk.IResolvable; /** * The ID or ARN of the service network or service for which the policy is created. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-authpolicy.html#cfn-vpclattice-authpolicy-resourceidentifier */ readonly resourceIdentifier: string; } /** * Creates a listener for a service. * * Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see [Listeners](https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html) in the *Amazon VPC Lattice User Guide* . * * @cloudformationResource AWS::VpcLattice::Listener * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html */ export declare class CfnListener extends cdk.CfnResource implements cdk.IInspectable, IListenerRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnListener 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): CfnListener; /** * Checks whether the given object is a CfnListener */ static isCfnListener(x: any): x is CfnListener; static arnForListener(resource: IListenerRef): string; /** * The action for the default rule. */ private _defaultAction; /** * The name of the listener. */ private _name?; /** * The listener port. */ private _port?; /** * The listener protocol. */ private _protocol; /** * The ID or ARN of the service. */ private _serviceIdentifier?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags for the listener. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::Listener`. * * @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: CfnListenerProps); get listenerRef(): ListenerReference; /** * The action for the default rule. */ get defaultAction(): CfnListener.DefaultActionProperty | cdk.IResolvable; /** * The action for the default rule. */ set defaultAction(value: CfnListener.DefaultActionProperty | cdk.IResolvable); /** * The name of the listener. */ get name(): string | undefined; /** * The name of the listener. */ set name(value: string | undefined); /** * The listener port. */ get port(): number | undefined; /** * The listener port. */ set port(value: number | undefined); /** * The listener protocol. */ get protocol(): string; /** * The listener protocol. */ set protocol(value: string); /** * The ID or ARN of the service. */ get serviceIdentifier(): string | undefined; /** * The ID or ARN of the service. */ set serviceIdentifier(value: string | undefined); /** * The tags for the listener. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * The tags for the listener. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The Amazon Resource Name (ARN) of the listener. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The ID of the listener. * * @cloudformationAttribute Id */ get attrId(): string; /** * The Amazon Resource Name (ARN) of the service. * * @cloudformationAttribute ServiceArn */ get attrServiceArn(): string; /** * The ID of the service. * * @cloudformationAttribute ServiceId */ get attrServiceId(): 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 CfnListener { /** * The action for the default rule. * * Each listener has a default rule. The default rule is used if no other rules match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html */ interface DefaultActionProperty { /** * Describes an action that returns a custom HTTP response. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html#cfn-vpclattice-listener-defaultaction-fixedresponse */ readonly fixedResponse?: CfnListener.FixedResponseProperty | cdk.IResolvable; /** * Describes a forward action. * * You can use forward actions to route requests to one or more target groups. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-defaultaction.html#cfn-vpclattice-listener-defaultaction-forward */ readonly forward?: CfnListener.ForwardProperty | cdk.IResolvable; } /** * The forward action. * * Traffic that matches the rule is forwarded to the specified target groups. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-forward.html */ interface ForwardProperty { /** * The target groups. * * Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. * * The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-forward.html#cfn-vpclattice-listener-forward-targetgroups */ readonly targetGroups: Array<cdk.IResolvable | CfnListener.WeightedTargetGroupProperty> | cdk.IResolvable; } /** * Describes the weight of a target group. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html */ interface WeightedTargetGroupProperty { /** * The ID of the target group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html#cfn-vpclattice-listener-weightedtargetgroup-targetgroupidentifier */ readonly targetGroupIdentifier: string; /** * Only required if you specify multiple target groups for a forward action. * * The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-weightedtargetgroup.html#cfn-vpclattice-listener-weightedtargetgroup-weight */ readonly weight?: number; } /** * Describes an action that returns a custom HTTP response. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-fixedresponse.html */ interface FixedResponseProperty { /** * The HTTP response code. * * Only `404` and `500` status codes are supported. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-listener-fixedresponse.html#cfn-vpclattice-listener-fixedresponse-statuscode */ readonly statusCode: number; } } /** * Properties for defining a `CfnListener` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html */ export interface CfnListenerProps { /** * The action for the default rule. * * Each listener has a default rule. The default rule is used if no other rules match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-defaultaction */ readonly defaultAction: CfnListener.DefaultActionProperty | cdk.IResolvable; /** * The name of the listener. * * A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. * * If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-name */ readonly name?: string; /** * The listener port. * * You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-port */ readonly port?: number; /** * The listener protocol. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-protocol */ readonly protocol: string; /** * The ID or ARN of the service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-serviceidentifier */ readonly serviceIdentifier?: string; /** * The tags for the listener. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Retrieves information about the specified resource policy. * * The resource policy is an IAM policy created on behalf of the resource owner when they share a resource. * * @cloudformationResource AWS::VpcLattice::ResourcePolicy * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html */ export declare class CfnResourcePolicy extends cdk.CfnResource implements cdk.IInspectable, IResourcePolicyRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnResourcePolicy 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): CfnResourcePolicy; /** * Checks whether the given object is a CfnResourcePolicy */ static isCfnResourcePolicy(x: any): x is CfnResourcePolicy; /** * The Amazon Resource Name (ARN) of the service network or service. */ private _policy; /** * An IAM policy. */ private _resourceArn; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::ResourcePolicy`. * * @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: CfnResourcePolicyProps); get resourcePolicyRef(): ResourcePolicyReference; /** * The Amazon Resource Name (ARN) of the service network or service. */ get policy(): any | cdk.IResolvable; /** * The Amazon Resource Name (ARN) of the service network or service. */ set policy(value: any | cdk.IResolvable); /** * An IAM policy. */ get resourceArn(): string; /** * An IAM policy. */ set resourceArn(value: 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 `CfnResourcePolicy` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html */ export interface CfnResourcePolicyProps { /** * The Amazon Resource Name (ARN) of the service network or service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html#cfn-vpclattice-resourcepolicy-policy */ readonly policy: any | cdk.IResolvable; /** * An IAM policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-resourcepolicy.html#cfn-vpclattice-resourcepolicy-resourcearn */ readonly resourceArn: string; } /** * Creates a listener rule. * * Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see [Listener rules](https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules) in the *Amazon VPC Lattice User Guide* . * * @cloudformationResource AWS::VpcLattice::Rule * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html */ export declare class CfnRule extends cdk.CfnResource implements cdk.IInspectable, IRuleRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnRule 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): CfnRule; /** * Checks whether the given object is a CfnRule */ static isCfnRule(x: any): x is CfnRule; static arnForRule(resource: IRuleRef): string; /** * Describes the action for a rule. */ private _action; /** * The ID or ARN of the listener. */ private _listenerIdentifier?; /** * The rule match. */ private _match; /** * The name of the rule. */ private _name?; /** * The priority assigned to the rule. */ private _priority; /** * The ID or ARN of the service. */ private _serviceIdentifier?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags for the rule. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::Rule`. * * @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: CfnRuleProps); get ruleRef(): RuleReference; /** * Describes the action for a rule. */ get action(): CfnRule.ActionProperty | cdk.IResolvable; /** * Describes the action for a rule. */ set action(value: CfnRule.ActionProperty | cdk.IResolvable); /** * The ID or ARN of the listener. */ get listenerIdentifier(): string | undefined; /** * The ID or ARN of the listener. */ set listenerIdentifier(value: string | undefined); /** * The rule match. */ get match(): cdk.IResolvable | CfnRule.MatchProperty; /** * The rule match. */ set match(value: cdk.IResolvable | CfnRule.MatchProperty); /** * The name of the rule. */ get name(): string | undefined; /** * The name of the rule. */ set name(value: string | undefined); /** * The priority assigned to the rule. */ get priority(): number; /** * The priority assigned to the rule. */ set priority(value: number); /** * The ID or ARN of the service. */ get serviceIdentifier(): string | undefined; /** * The ID or ARN of the service. */ set serviceIdentifier(value: string | undefined); /** * The tags for the rule. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * The tags for the rule. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The Amazon Resource Name (ARN) of the rule. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The ID of the listener. * * @cloudformationAttribute Id */ get attrId(): 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 CfnRule { /** * Describes the action for a rule. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html */ interface ActionProperty { /** * The fixed response action. * * The rule returns a custom HTTP response. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html#cfn-vpclattice-rule-action-fixedresponse */ readonly fixedResponse?: CfnRule.FixedResponseProperty | cdk.IResolvable; /** * The forward action. * * Traffic that matches the rule is forwarded to the specified target groups. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-action.html#cfn-vpclattice-rule-action-forward */ readonly forward?: CfnRule.ForwardProperty | cdk.IResolvable; } /** * The forward action. * * Traffic that matches the rule is forwarded to the specified target groups. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html */ interface ForwardProperty { /** * The target groups. * * Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic. * * The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-forward.html#cfn-vpclattice-rule-forward-targetgroups */ readonly targetGroups: Array<cdk.IResolvable | CfnRule.WeightedTargetGroupProperty> | cdk.IResolvable; } /** * Describes the weight of a target group. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html */ interface WeightedTargetGroupProperty { /** * The ID of the target group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-targetgroupidentifier */ readonly targetGroupIdentifier: string; /** * Only required if you specify multiple target groups for a forward action. * * The weight determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-weightedtargetgroup.html#cfn-vpclattice-rule-weightedtargetgroup-weight */ readonly weight?: number; } /** * Describes an action that returns a custom HTTP response. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html */ interface FixedResponseProperty { /** * The HTTP response code. * * Only `404` and `500` status codes are supported. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-fixedresponse.html#cfn-vpclattice-rule-fixedresponse-statuscode */ readonly statusCode: number; } /** * Describes a rule match. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-match.html */ interface MatchProperty { /** * The HTTP criteria that a rule must match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-match.html#cfn-vpclattice-rule-match-httpmatch */ readonly httpMatch: CfnRule.HttpMatchProperty | cdk.IResolvable; } /** * Describes criteria that can be applied to incoming requests. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html */ interface HttpMatchProperty { /** * The header matches. * * Matches incoming requests with rule based on request header value before applying rule action. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-headermatches */ readonly headerMatches?: Array<CfnRule.HeaderMatchProperty | cdk.IResolvable> | cdk.IResolvable; /** * The HTTP method type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-method */ readonly method?: string; /** * The path match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-httpmatch.html#cfn-vpclattice-rule-httpmatch-pathmatch */ readonly pathMatch?: cdk.IResolvable | CfnRule.PathMatchProperty; } /** * Describes the constraints for a header match. * * Matches incoming requests with rule based on request header value before applying rule action. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html */ interface HeaderMatchProperty { /** * Indicates whether the match is case sensitive. * * @default - false * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-casesensitive */ readonly caseSensitive?: boolean | cdk.IResolvable; /** * The header match type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-match */ readonly match: CfnRule.HeaderMatchTypeProperty | cdk.IResolvable; /** * The name of the header. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatch.html#cfn-vpclattice-rule-headermatch-name */ readonly name: string; } /** * Describes a header match type. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html */ interface HeaderMatchTypeProperty { /** * A contains type match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-contains */ readonly contains?: string; /** * An exact type match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-exact */ readonly exact?: string; /** * A prefix type match. * * Matches the value with the prefix. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-headermatchtype.html#cfn-vpclattice-rule-headermatchtype-prefix */ readonly prefix?: string; } /** * Describes the conditions that can be applied when matching a path for incoming requests. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html */ interface PathMatchProperty { /** * Indicates whether the match is case sensitive. * * @default - false * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html#cfn-vpclattice-rule-pathmatch-casesensitive */ readonly caseSensitive?: boolean | cdk.IResolvable; /** * The type of path match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatch.html#cfn-vpclattice-rule-pathmatch-match */ readonly match: cdk.IResolvable | CfnRule.PathMatchTypeProperty; } /** * Describes a path match type. * * Each rule can include only one of the following types of paths. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html */ interface PathMatchTypeProperty { /** * An exact match of the path. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html#cfn-vpclattice-rule-pathmatchtype-exact */ readonly exact?: string; /** * A prefix match of the path. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-rule-pathmatchtype.html#cfn-vpclattice-rule-pathmatchtype-prefix */ readonly prefix?: string; } } /** * Properties for defining a `CfnRule` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html */ export interface CfnRuleProps { /** * Describes the action for a rule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-action */ readonly action: CfnRule.ActionProperty | cdk.IResolvable; /** * The ID or ARN of the listener. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-listeneridentifier */ readonly listenerIdentifier?: string; /** * The rule match. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-match */ readonly match: cdk.IResolvable | CfnRule.MatchProperty; /** * The name of the rule. * * The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. * * If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-name */ readonly name?: string; /** * The priority assigned to the rule. * * Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-priority */ readonly priority: number; /** * The ID or ARN of the service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-serviceidentifier */ readonly serviceIdentifier?: string; /** * The tags for the rule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-rule.html#cfn-vpclattice-rule-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Creates a service. * * A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). * * For more information, see [Services](https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) in the *Amazon VPC Lattice User Guide* . * * @cloudformationResource AWS::VpcLattice::Service * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html */ export declare class CfnService extends cdk.CfnResource implements cdk.IInspectable, IServiceRef, cdk.ITaggable { /** * 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; /** * The type of IAM policy. */ private _authType?; /** * The Amazon Resource Name (ARN) of the certificate. */ private _certificateArn?; /** * The custom domain name of the service. */ private _customDomainName?; /** * Describes the DNS information of the service. */ private _dnsEntry?; /** * The name of the service. */ private _name?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags for the service. */ private _tagsRaw?; protected readonly cfnPropertyNames: Record<string, string>; /** * Create a new `AWS::VpcLattice::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; /** * The type of IAM policy. */ get authType(): string | undefined; /** * The type of IAM policy. */ set authType(value: string | undefined); /** * The Amazon Resource Name (ARN) of the certificate. */ get certificateArn(): string | undefined; /** * The Amazon Resource Name (ARN) of the certificate. */ set certificateArn(value: string | undefined); /** * The custom domain name of the service. */ get customDomainName(): string | undefined; /** * The custom domain name of the service. */ set customDomainName(value: string | undefined); /** * Describes the DNS information of the service. */ get dnsEntry(): CfnService.DnsEntryProperty | cdk.IResolvable | undefined; /** * Describes the DNS information of the service. */ set dnsEntry(value: CfnService.DnsEntryProperty | cdk.IResolvable | undefined); /** * The name of the service. */ get name(): string | undefined; /** * The name of the service. */ set name(value: string | undefined); /** * The tags for the service. */ get tagsRaw(): Array<cdk.CfnTag> | undefined; /** * The tags for the service. */ set tagsRaw(value: Array<cdk.CfnTag> | undefined); /** * The Amazon Resource Name (ARN) of the service. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The date and time that the service was created, specified in ISO-8601 format. * * @cloudformationAttribute CreatedAt */ get attrCreatedAt(): string; /** * The domain name of the service. * * @cloudformationAttribute DnsEntry.DomainName */ get attrDnsEntryDomainName(): string; /** * The ID of the hosted zone. * * @cloudformationAttribute DnsEntry.HostedZoneId */ get attrDnsEntryHostedZoneId(): string; /** * The ID of the service. * * @cloudformationAttribute Id */ get attrId(): string; /** * The date and time that the service was last updated, specified in ISO-8601 format. * * @cloudformationAttribute LastUpdatedAt */ get attrLastUpdatedAt(): string; /** * The status of the service. * * @cloudformationAttribute Status */ get attrStatus(): 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 { /** * Describes the DNS information of a service. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html */ interface DnsEntryProperty { /** * The domain name of the service. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-domainname */ readonly domainName?: string; /** * The ID of the hosted zone. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-vpclattice-service-dnsentry.html#cfn-vpclattice-service-dnsentry-hostedzoneid */ readonly hostedZoneId?: string; } } /** * Properties for defining a `CfnService` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html */ export interface CfnServiceProps { /** * The type of IAM policy. * * - `NONE` : The resource