package awsapigateway import ( _init_ "github.com/aws/aws-cdk-go/awscdk/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/constructs-go/constructs/v10" ) // Example: // // production stage // prdLogGroup := logs.NewLogGroup(this, jsii.String("PrdLogs")) // api := apigateway.NewRestApi(this, jsii.String("books"), &RestApiProps{ // DeployOptions: &StageOptions{ // AccessLogDestination: apigateway.NewLogGroupLogDestination(prdLogGroup), // AccessLogFormat: apigateway.AccessLogFormat_JsonWithStandardFields(), // }, // }) // deployment := apigateway.NewDeployment(this, jsii.String("Deployment"), &DeploymentProps{ // Api: Api, // }) // // // development stage // devLogGroup := logs.NewLogGroup(this, jsii.String("DevLogs")) // apigateway.NewStage(this, jsii.String("dev"), &StageProps{ // Deployment: Deployment, // AccessLogDestination: apigateway.NewLogGroupLogDestination(devLogGroup), // AccessLogFormat: apigateway.AccessLogFormat_*JsonWithStandardFields(&JsonWithStandardFieldProps{ // Caller: jsii.Boolean(false), // HttpMethod: jsii.Boolean(true), // Ip: jsii.Boolean(true), // Protocol: jsii.Boolean(true), // RequestTime: jsii.Boolean(true), // ResourcePath: jsii.Boolean(true), // ResponseLength: jsii.Boolean(true), // Status: jsii.Boolean(true), // User: jsii.Boolean(true), // }), // }) // type Stage interface { StageBase // 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. Env() *awscdk.ResourceEnvironment // The tree node. 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. PhysicalName() *string // RestApi to which this stage is associated. RestApi() IRestApi // The stack in which this resource is defined. Stack() awscdk.Stack // Returns the resource ARN for this stage:. // // arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName} // // Note that this is separate from the execute-api ARN for methods and resources // within this stage. StageArn() *string // Name of this stage. StageName() *string // Add an ApiKey to this stage. AddApiKey(id *string, options *ApiKeyOptions) IApiKey // 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`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) 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`. 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. GetResourceNameAttribute(nameAttr *string) *string // Returns the given named metric for this stage. Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of requests served from the API cache in a given period. MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of requests served from the backend in a given period, when API caching is enabled. MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of client-side errors captured in a given period. MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the total number API requests in a given period. MetricCount(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. 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. MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of server-side errors captured in a given period. MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Returns a string representation of this construct. ToString() *string // Returns the invoke URL for a certain path. UrlForPath(path *string) *string } // The jsii proxy struct for Stage type jsiiProxy_Stage struct { jsiiProxy_StageBase } func (j *jsiiProxy_Stage) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_Stage) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Stage) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_Stage) RestApi() IRestApi { var returns IRestApi _jsii_.Get( j, "restApi", &returns, ) return returns } func (j *jsiiProxy_Stage) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_Stage) StageArn() *string { var returns *string _jsii_.Get( j, "stageArn", &returns, ) return returns } func (j *jsiiProxy_Stage) StageName() *string { var returns *string _jsii_.Get( j, "stageName", &returns, ) return returns } func NewStage(scope constructs.Construct, id *string, props *StageProps) Stage { _init_.Initialize() if err := validateNewStageParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_Stage{} _jsii_.Create( "aws-cdk-lib.aws_apigateway.Stage", []interface{}{scope, id, props}, &j, ) return &j } func NewStage_Override(s Stage, scope constructs.Construct, id *string, props *StageProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_apigateway.Stage", []interface{}{scope, id, props}, s, ) } // Import a Stage by its attributes. func Stage_FromStageAttributes(scope constructs.Construct, id *string, attrs *StageAttributes) IStage { _init_.Initialize() if err := validateStage_FromStageAttributesParameters(scope, id, attrs); err != nil { panic(err) } var returns IStage _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Stage", "fromStageAttributes", []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`. func Stage_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateStage_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Stage", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func Stage_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateStage_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Stage", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func Stage_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateStage_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Stage", "isResource", []interface{}{construct}, &returns, ) return returns } func (s *jsiiProxy_Stage) AddApiKey(id *string, options *ApiKeyOptions) IApiKey { if err := s.validateAddApiKeyParameters(id, options); err != nil { panic(err) } var returns IApiKey _jsii_.Invoke( s, "addApiKey", []interface{}{id, options}, &returns, ) return returns } func (s *jsiiProxy_Stage) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := s.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( s, "applyRemovalPolicy", []interface{}{policy}, ) } func (s *jsiiProxy_Stage) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( s, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (s *jsiiProxy_Stage) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := s.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (s *jsiiProxy_Stage) GetResourceNameAttribute(nameAttr *string) *string { if err := s.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( s, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (s *jsiiProxy_Stage) Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricParameters(metricName, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metric", []interface{}{metricName, props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricCacheHitCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricCacheHitCountParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricCacheHitCount", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricCacheMissCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricCacheMissCountParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricCacheMissCount", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricClientError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricClientErrorParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricClientError", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricCount(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricCountParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricCount", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricIntegrationLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricIntegrationLatencyParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricIntegrationLatency", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricLatency(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricLatencyParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricLatency", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) MetricServerError(props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := s.validateMetricServerErrorParameters(props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( s, "metricServerError", []interface{}{props}, &returns, ) return returns } func (s *jsiiProxy_Stage) ToString() *string { var returns *string _jsii_.Invoke( s, "toString", nil, // no parameters &returns, ) return returns } func (s *jsiiProxy_Stage) UrlForPath(path *string) *string { var returns *string _jsii_.Invoke( s, "urlForPath", []interface{}{path}, &returns, ) return returns }