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" ) // A Deployment of a REST API. // // An immutable representation of a RestApi resource that can be called by users // using Stages. A deployment must be associated with a Stage for it to be // callable over the Internet. // // Normally, you don't need to define deployments manually. The RestApi // construct manages a Deployment resource that represents the latest model. It // can be accessed through `restApi.latestDeployment` (unless `deploy: false` is // set when defining the `RestApi`). // // If you manually define this resource, you will need to know that since // deployments are immutable, as long as the resource's logical ID doesn't // change, the deployment will represent the snapshot in time in which the // resource was created. This means that if you modify the RestApi model (i.e. // add methods or resources), these changes will not be reflected unless a new // deployment resource is created. // // To achieve this behavior, the method `addToLogicalId(data)` can be used to // augment the logical ID generated for the deployment resource such that it // will include arbitrary data. This is done automatically for the // `restApi.latestDeployment` deployment. // // Furthermore, since a deployment does not reference any of the REST API // resources and methods, CloudFormation will likely provision it before these // resources are created, which means that it will represent a "half-baked" // model. Use the `node.addDependency(dep)` method to circumvent that. This is done // automatically for the `restApi.latestDeployment` deployment. // // 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 Deployment interface { awscdk.Resource Api() IRestApi DeploymentId() *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. 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 // Adds a component to the hash that determines this Deployment resource's logical ID. // // This should be called by constructs of the API Gateway model that want to // invalidate the deployment when their settings change. The component will // be resolve()ed during synthesis so tokens are welcome. AddToLogicalId(data interface{}) // 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 Deployment type jsiiProxy_Deployment struct { internal.Type__awscdkResource } func (j *jsiiProxy_Deployment) Api() IRestApi { var returns IRestApi _jsii_.Get( j, "api", &returns, ) return returns } func (j *jsiiProxy_Deployment) DeploymentId() *string { var returns *string _jsii_.Get( j, "deploymentId", &returns, ) return returns } func (j *jsiiProxy_Deployment) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_Deployment) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Deployment) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_Deployment) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func NewDeployment(scope constructs.Construct, id *string, props *DeploymentProps) Deployment { _init_.Initialize() if err := validateNewDeploymentParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_Deployment{} _jsii_.Create( "aws-cdk-lib.aws_apigateway.Deployment", []interface{}{scope, id, props}, &j, ) return &j } func NewDeployment_Override(d Deployment, scope constructs.Construct, id *string, props *DeploymentProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_apigateway.Deployment", []interface{}{scope, id, props}, d, ) } // 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 Deployment_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateDeployment_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Deployment", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func Deployment_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateDeployment_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Deployment", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func Deployment_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateDeployment_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_apigateway.Deployment", "isResource", []interface{}{construct}, &returns, ) return returns } func (d *jsiiProxy_Deployment) AddToLogicalId(data interface{}) { if err := d.validateAddToLogicalIdParameters(data); err != nil { panic(err) } _jsii_.InvokeVoid( d, "addToLogicalId", []interface{}{data}, ) } func (d *jsiiProxy_Deployment) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := d.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( d, "applyRemovalPolicy", []interface{}{policy}, ) } func (d *jsiiProxy_Deployment) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( d, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (d *jsiiProxy_Deployment) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := d.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( d, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (d *jsiiProxy_Deployment) GetResourceNameAttribute(nameAttr *string) *string { if err := d.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( d, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (d *jsiiProxy_Deployment) ToString() *string { var returns *string _jsii_.Invoke( d, "toString", nil, // no parameters &returns, ) return returns }