RestApiProps Struct
Props to create a new instance of RestApi.
Example
const gateway = new agentcore.Gateway(this, "MyGateway", {
gatewayName: "my-gateway",
});
const api = new apigateway.RestApi(this, 'MyApi', {
restApiName: 'my-api',
});
// Uses IAM authorization for outbound auth by default
const apiGatewayTarget = gateway.addApiGatewayTarget("MyApiGatewayTarget", {
restApi: api,
apiGatewayToolConfiguration: {
toolFilters: [
{
filterPath: "/pets/*",
methods: [agentcore.ApiGatewayHttpMethod.GET],
},
],
},
});
Properties
apiKeySourceTypeoptionalApiKeySourceTypeapi_key_source_typeoptionalApiKeySourceTypeapiKeySourceTypeoptionalApiKeySourceTypeApiKeySourceTypeoptionalApiKeySourceTypeApiKeySourceTypeoptionalApiKeySourceType#Default: Metering is disabled.
binaryMediaTypesoptionalstring[]binary_media_typesoptionaltyping.List[str]binaryMediaTypesoptionalList<String>BinaryMediaTypesoptionalstring[]BinaryMediaTypesoptional*[]*string#Default: RestApi supports only UTF-8-encoded text payloads.
cloneFromoptionalIRestApiclone_fromoptionalIRestApicloneFromoptionalIRestApiCloneFromoptionalIRestApiCloneFromoptionalIRestApi= None.#cloudWatchRoleoptionalbooleancloud_watch_roleoptionalboolcloudWatchRoleoptionalBooleanCloudWatchRoleoptionalboolCloudWatchRoleoptional*bool#Default: false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise
cloudWatchRoleRemovalPolicyoptionalRemovalPolicycloud_watch_role_removal_policyoptionalRemovalPolicycloudWatchRoleRemovalPolicyoptionalRemovalPolicyCloudWatchRoleRemovalPolicyoptionalRemovalPolicyCloudWatchRoleRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#Requires cloudWatchRole to be enabled.
defaultCorsPreflightOptionsoptionalCorsOptionsdefault_cors_preflight_optionsoptionalCorsOptionsdefaultCorsPreflightOptionsoptionalCorsOptionsDefaultCorsPreflightOptionsoptionalCorsOptionsDefaultCorsPreflightOptionsoptionalCorsOptions#Default: CORS is disabled
You can add CORS at the resource-level using addCorsPreflight.
defaultIntegrationoptionalIntegrationdefault_integrationoptionalIntegrationdefaultIntegrationoptionalIntegrationDefaultIntegrationoptionalIntegrationDefaultIntegrationoptionalIntegration#Default: Inherited from parent.
defaultMethodOptionsoptionalMethodOptionsdefault_method_optionsoptionalMethodOptionsdefaultMethodOptionsoptionalMethodOptionsDefaultMethodOptionsoptionalMethodOptionsDefaultMethodOptionsoptionalMethodOptions#Default: Inherited from parent.
deployoptionalbooleandeployoptionalbooldeployoptionalBooleanDeployoptionalboolDeployoptional*bool= true#notes
Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.
If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.
A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
deployOptionsoptionalStageOptionsdeploy_optionsoptionalStageOptionsdeployOptionsoptionalStageOptionsDeployOptionsoptionalStageOptionsDeployOptionsoptionalStageOptions#Default: Based on defaults of StageOptions.
If deploy is disabled, this value cannot be set.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: 'Automatically created by the RestApi construct'
disableExecuteApiEndpointoptionalbooleandisable_execute_api_endpointoptionalbooldisableExecuteApiEndpointoptionalBooleanDisableExecuteApiEndpointoptionalboolDisableExecuteApiEndpointoptional*bool= false#To require that clients use a custom domain name to invoke the API, disable the default endpoint.
domainNameoptionalDomainNameOptionsdomain_nameoptionalDomainNameOptionsdomainNameoptionalDomainNameOptionsDomainNameoptionalDomainNameOptionsDomainNameoptionalDomainNameOptions#Default: no domain name is defined, use addDomainName or directly define a DomainName.
endpointConfigurationoptionalEndpointConfigurationendpoint_configurationoptionalEndpointConfigurationendpointConfigurationoptionalEndpointConfigurationEndpointConfigurationoptionalEndpointConfigurationEndpointConfigurationoptionalEndpointConfiguration= EndpointType.EDGE#endpointExportNameoptionalstringendpoint_export_nameoptionalstrendpointExportNameoptionalStringEndpointExportNameoptionalstringEndpointExportNameoptional*string#Default: when no export name is given, output will be created without export
endpointTypesoptionalEndpointType[]endpoint_typesoptionaltyping.List[EndpointType]endpointTypesoptionalList<EndpointType>EndpointTypesoptionalEndpointType[]EndpointTypesoptional*[]EndpointType= EndpointType.EDGE#Use this property when creating an API.
failOnWarningsoptionalbooleanfail_on_warningsoptionalboolfailOnWarningsoptionalBooleanFailOnWarningsoptionalboolFailOnWarningsoptional*bool= false#minCompressionSizeoptionalSizemin_compression_sizeoptionalSizeminCompressionSizeoptionalSizeMinCompressionSizeoptionalSizeMinCompressionSizeoptionalSize#Default: Compression is disabled.
When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
minimumCompressionSizeoptionalnumberminimum_compression_sizeoptionalint | floatminimumCompressionSizeoptionalNumberMinimumCompressionSizeoptionaldoubleMinimumCompressionSizeoptional*float64deprecated#Default: Compression is disabled.
When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string#Default: No parameters.
policyoptionalPolicyDocumentpolicyoptionalPolicyDocumentpolicyoptionalPolicyDocumentPolicyoptionalPolicyDocumentPolicyoptionalPolicyDocument#Default: No policy.
restApiNameoptionalstringrest_api_nameoptionalstrrestApiNameoptionalStringRestApiNameoptionalstringRestApiNameoptional*string#Default: ID of the RestApi construct.
retainDeploymentsoptionalbooleanretain_deploymentsoptionalboolretainDeploymentsoptionalBooleanRetainDeploymentsoptionalboolRetainDeploymentsoptional*bool= false#This allows manually reverting stages to point to old deployments via the AWS Console.