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/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 UsagePlan interface { awscdk.Resource IUsagePlan // 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 // The stack in which this resource is defined. Stack() awscdk.Stack // Id of the usage plan. UsagePlanId() *string // Adds an ApiKey. AddApiKey(apiKey IApiKey, options *AddApiKeyOptions) // Adds an apiStage. AddApiStage(apiStage *UsagePlanPerApiStage) // 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 a string representation of this construct. ToString() *string } // The jsii proxy struct for UsagePlan type jsiiProxy_UsagePlan struct { internal.Type__awscdkResource jsiiProxy_IUsagePlan } func (j *jsiiProxy_UsagePlan) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_UsagePlan) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_UsagePlan) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_UsagePlan) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func (j *jsiiProxy_UsagePlan) UsagePlanId() *string { var returns *string _jsii_.Get( j, "usagePlanId", &returns, ) return returns } func NewUsagePlan(scope constructs.Construct, id *string, props *UsagePlanProps) UsagePlan { _init_.Initialize() if err := validateNewUsagePlanParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_UsagePlan{} _jsii_.Create( "aws-cdk-lib.aws_apigateway.UsagePlan", []interface{}{scope, id, props}, &j, ) return &j } func NewUsagePlan_Override(u UsagePlan, scope constructs.Construct, id *string, props *UsagePlanProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_apigateway.UsagePlan", []interface{}{scope, id, props}, u, ) } // Import an externally defined usage plan using its ARN. func UsagePlan_FromUsagePlanId(scope constructs.Construct, id *string, usagePlanId *string) IUsagePlan { _init_.Initialize() if err := validateUsagePlan_FromUsagePlanIdParameters(scope, id, usagePlanId); err != nil { panic(err) } var returns IUsagePlan _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.UsagePlan", "fromUsagePlanId", []interface{}{scope, id, usagePlanId}, &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 UsagePlan_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateUsagePlan_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.UsagePlan", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func UsagePlan_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateUsagePlan_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.UsagePlan", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func UsagePlan_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateUsagePlan_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.UsagePlan", "isResource", []interface{}{construct}, &returns, ) return returns } func (u *jsiiProxy_UsagePlan) AddApiKey(apiKey IApiKey, options *AddApiKeyOptions) { if err := u.validateAddApiKeyParameters(apiKey, options); err != nil { panic(err) } _jsii_.InvokeVoid( u, "addApiKey", []interface{}{apiKey, options}, ) } func (u *jsiiProxy_UsagePlan) AddApiStage(apiStage *UsagePlanPerApiStage) { if err := u.validateAddApiStageParameters(apiStage); err != nil { panic(err) } _jsii_.InvokeVoid( u, "addApiStage", []interface{}{apiStage}, ) } func (u *jsiiProxy_UsagePlan) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := u.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( u, "applyRemovalPolicy", []interface{}{policy}, ) } func (u *jsiiProxy_UsagePlan) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( u, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (u *jsiiProxy_UsagePlan) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := u.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( u, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (u *jsiiProxy_UsagePlan) GetResourceNameAttribute(nameAttr *string) *string { if err := u.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( u, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (u *jsiiProxy_UsagePlan) ToString() *string { var returns *string _jsii_.Invoke( u, "toString", nil, // no parameters &returns, ) return returns }