package awscdkapigatewayv2alpha import ( _init_ "github.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch" "github.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2/internal" "github.com/aws/constructs-go/constructs/v10" ) // Represents a stage where an instance of the API is deployed. // // Example: // var api httpApi // // // apigwv2.NewHttpStage(this, jsii.String("Stage"), &HttpStageProps{ // HttpApi: api, // StageName: jsii.String("beta"), // }) // // Experimental. type HttpStage interface { awscdk.Resource IHttpStage IStage // The API this stage is associated to. // Experimental. Api() IHttpApi // Experimental. BaseApi() IApi // The custom domain URL to this stage. // Experimental. DomainUrl() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The tree node. // Experimental. Node() constructs.Node // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // The name of the stage; // // its primary identifier. // Experimental. StageName() *string // The URL to this stage. // Experimental. Url() *string // Apply the given removal policy to this resource. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Return the given named metric for this HTTP Api Gateway Stage. // Experimental. Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of client-side errors captured in a given period. // Experimental. MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the total number API requests in a given period. // Experimental. MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the amount of data processed in bytes. // Experimental. MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. // Experimental. MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // The time between when API Gateway receives a request from a client and when it returns a response to the client. // // The latency includes the integration latency and other API Gateway overhead. // Experimental. MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of server-side errors captured in a given period. // Experimental. MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Returns a string representation of this construct. // Experimental. ToString() *string } // The jsii proxy struct for HttpStage type jsiiProxy_HttpStage struct { internal.Type__awscdkResource jsiiProxy_IHttpStage jsiiProxy_IStage } func (j *jsiiProxy_HttpStage) Api() IHttpApi { var returns IHttpApi _jsii_.Get( j, "api", &returns, ) return returns } func (j *jsiiProxy_HttpStage) BaseApi() IApi { var returns IApi _jsii_.Get( j, "baseApi", &returns, ) return returns } func (j *jsiiProxy_HttpStage) DomainUrl() *string { var returns *string _jsii_.Get( j, "domainUrl", &returns, ) return returns } func (j *jsiiProxy_HttpStage) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_HttpStage) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_HttpStage) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_HttpStage) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_HttpStage) StageName() *string { var returns *string _jsii_.Get( j, "stageName", &returns, ) return returns } func (j *jsiiProxy_HttpStage) Url() *string { var returns *string _jsii_.Get( j, "url", &returns, ) return returns } // Experimental. func NewHttpStage(scope constructs.Construct, id *string, props *HttpStageProps) HttpStage { _init_.Initialize() if err := validateNewHttpStageParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_HttpStage{} _jsii_.Create( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", []interface{}{scope, id, props}, &j, ) return &j } // Experimental. func NewHttpStage_Override(h HttpStage, scope constructs.Construct, id *string, props *HttpStageProps) { _init_.Initialize() _jsii_.Create( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", []interface{}{scope, id, props}, h, ) } // Import an existing stage into this CDK app. // Experimental. func HttpStage_FromHttpStageAttributes(scope constructs.Construct, id *string, attrs *HttpStageAttributes) IHttpStage { _init_.Initialize() if err := validateHttpStage_FromHttpStageAttributesParameters(scope, id, attrs); err != nil { panic(err) } var returns IHttpStage _jsii_.StaticInvoke( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", "fromHttpStageAttributes", []interface{}{scope, id, attrs}, &returns, ) return returns } // Checks if `x` is a construct. // // Use this method instead of `instanceof` to properly detect `Construct` // instances, even when the construct library is symlinked. // // Explanation: in JavaScript, multiple copies of the `constructs` library on // disk are seen as independent, completely different libraries. As a // consequence, the class `Construct` in each copy of the `constructs` library // is seen as a different class, and an instance of one class will not test as // `instanceof` the other class. `npm install` will not create installations // like this, but users may manually symlink construct libraries together or // use a monorepo tool: in those cases, multiple copies of the `constructs` // library can be accidentally installed, and `instanceof` will behave // unpredictably. It is safest to avoid using `instanceof`, and using // this type-testing method instead. // // Returns: true if `x` is an object created from a class which extends `Construct`. // Experimental. func HttpStage_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateHttpStage_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. // Experimental. func HttpStage_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateHttpStage_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. // Experimental. func HttpStage_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateHttpStage_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "@aws-cdk/aws-apigatewayv2-alpha.HttpStage", "isResource", []interface{}{construct}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := h.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( h, "applyRemovalPolicy", []interface{}{policy}, ) } func (h *jsiiProxy_HttpStage) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( h, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (h *jsiiProxy_HttpStage) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := h.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( h, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) GetResourceNameAttribute(nameAttr *string) *string { if err := h.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( h, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricParameters(metricName, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metric", []interface{}{metricName, props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricClientErrorParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricClientError", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricCountParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricCount", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricDataProcessed(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricDataProcessedParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricDataProcessed", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricIntegrationLatencyParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricIntegrationLatency", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricLatencyParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricLatency", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := h.validateMetricServerErrorParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( h, "metricServerError", []interface{}{props}, &returns, ) return returns } func (h *jsiiProxy_HttpStage) ToString() *string { var returns *string _jsii_.Invoke( h, "toString", nil, // no parameters &returns, ) return returns }