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/awsapigateway/internal" "github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch" "github.com/aws/aws-cdk-go/awscdk/v2/awsiam" "github.com/aws/constructs-go/constructs/v10" ) // Example: // var integration lambdaIntegration // // // api := apigateway.NewRestApi(this, jsii.String("hello-api")) // // v1 := api.Root.AddResource(jsii.String("v1")) // echo := v1.AddResource(jsii.String("echo")) // echoMethod := echo.AddMethod(jsii.String("GET"), integration, &MethodOptions{ // ApiKeyRequired: jsii.Boolean(true), // }) // // plan := api.AddUsagePlan(jsii.String("UsagePlan"), &UsagePlanProps{ // Name: jsii.String("Easy"), // Throttle: &ThrottleSettings{ // RateLimit: jsii.Number(10), // BurstLimit: jsii.Number(2), // }, // }) // // key := api.AddApiKey(jsii.String("ApiKey")) // plan.addApiKey(key) // type Method interface { awscdk.Resource // The API Gateway RestApi associated with this method. Api() IRestApi // 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 HttpMethod() *string // Returns an execute-api ARN for this method:. // // arn:aws:execute-api:{region}:{account}:{restApiId}/{stage}/{method}/{path} // // NOTE: {stage} will refer to the `restApi.deploymentStage`, which will // automatically set if auto-deploy is enabled, or can be explicitly assigned. // When not configured, {stage} will be set to '*', as a shorthand for 'all stages'. MethodArn() *string MethodId() *string // 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 Resource() IResource // The stack in which this resource is defined. Stack() awscdk.Stack // Returns an execute-api ARN for this method's "test-invoke-stage" stage. // // This stage is used by the AWS Console UI when testing the method. TestMethodArn() *string // Add a method response to this method. AddMethodResponse(methodResponse *MethodResponse) // 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 // Grants an IAM principal permission to invoke this method. GrantExecute(grantee awsiam.IGrantable) awsiam.Grant // Returns the given named metric for this API method. Metric(metricName *string, stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of requests served from the API cache in a given period. MetricCacheHitCount(stage IStage, 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(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of client-side errors captured in a given period. MetricClientError(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the total number API requests in a given period. MetricCount(stage IStage, 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(stage IStage, 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(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Metric for the number of server-side errors captured in a given period. MetricServerError(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for Method type jsiiProxy_Method struct { internal.Type__awscdkResource } func (j *jsiiProxy_Method) Api() IRestApi { var returns IRestApi _jsii_.Get( j, "api", &returns, ) return returns } func (j *jsiiProxy_Method) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_Method) HttpMethod() *string { var returns *string _jsii_.Get( j, "httpMethod", &returns, ) return returns } func (j *jsiiProxy_Method) MethodArn() *string { var returns *string _jsii_.Get( j, "methodArn", &returns, ) return returns } func (j *jsiiProxy_Method) MethodId() *string { var returns *string _jsii_.Get( j, "methodId", &returns, ) return returns } func (j *jsiiProxy_Method) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Method) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_Method) Resource() IResource { var returns IResource _jsii_.Get( j, "resource", &returns, ) return returns } func (j *jsiiProxy_Method) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_Method) TestMethodArn() *string { var returns *string _jsii_.Get( j, "testMethodArn", &returns, ) return returns } func NewMethod(scope constructs.Construct, id *string, props *MethodProps) Method { _init_.Initialize() if err := validateNewMethodParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_Method{} _jsii_.Create( "aws-cdk-lib.aws_apigateway.Method", []interface{}{scope, id, props}, &j, ) return &j } func NewMethod_Override(m Method, scope constructs.Construct, id *string, props *MethodProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_apigateway.Method", []interface{}{scope, id, props}, m, ) } // 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 Method_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateMethod_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Method", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func Method_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateMethod_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Method", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func Method_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateMethod_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Method", "isResource", []interface{}{construct}, &returns, ) return returns } func (m *jsiiProxy_Method) AddMethodResponse(methodResponse *MethodResponse) { if err := m.validateAddMethodResponseParameters(methodResponse); err != nil { panic(err) } _jsii_.InvokeVoid( m, "addMethodResponse", []interface{}{methodResponse}, ) } func (m *jsiiProxy_Method) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := m.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( m, "applyRemovalPolicy", []interface{}{policy}, ) } func (m *jsiiProxy_Method) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( m, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (m *jsiiProxy_Method) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := m.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( m, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (m *jsiiProxy_Method) GetResourceNameAttribute(nameAttr *string) *string { if err := m.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( m, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (m *jsiiProxy_Method) GrantExecute(grantee awsiam.IGrantable) awsiam.Grant { if err := m.validateGrantExecuteParameters(grantee); err != nil { panic(err) } var returns awsiam.Grant _jsii_.Invoke( m, "grantExecute", []interface{}{grantee}, &returns, ) return returns } func (m *jsiiProxy_Method) Metric(metricName *string, stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricParameters(metricName, stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metric", []interface{}{metricName, stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricCacheHitCount(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricCacheHitCountParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricCacheHitCount", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricCacheMissCount(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricCacheMissCountParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricCacheMissCount", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricClientError(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricClientErrorParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricClientError", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricCount(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricCountParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricCount", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricIntegrationLatency(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricIntegrationLatencyParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricIntegrationLatency", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricLatency(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricLatencyParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricLatency", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) MetricServerError(stage IStage, props *awscloudwatch.MetricOptions) awscloudwatch.Metric { if err := m.validateMetricServerErrorParameters(stage, props); err != nil { panic(err) } var returns awscloudwatch.Metric _jsii_.Invoke( m, "metricServerError", []interface{}{stage, props}, &returns, ) return returns } func (m *jsiiProxy_Method) ToString() *string { var returns *string _jsii_.Invoke( m, "toString", nil, // no parameters &returns, ) return returns }