# API Reference
## Constructs
### TypeSafeRestApi
A construct for creating an api gateway rest api based on the definition in the OpenAPI spec.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeRestApi(
scope: Construct,
id: str,
cloud_watch_role: bool = None,
deploy: bool = None,
deploy_options: StageOptions = None,
description: str = None,
disable_execute_api_endpoint: bool = None,
domain_name: DomainNameOptions = None,
endpoint_export_name: str = None,
endpoint_types: typing.List[EndpointType] = None,
fail_on_warnings: bool = None,
parameters: typing.Mapping[str] = None,
policy: PolicyDocument = None,
rest_api_name: str = None,
retain_deployments: bool = None,
integrations: typing.Mapping[TypeSafeApiIntegration],
operation_lookup: typing.Mapping[OperationDetails],
api_key_options: ApiKeyOptions = None,
cors_options: CorsOptions = None,
default_authorizer: Authorizer = None,
spec_path: str,
min_compression_size: Size = None,
web_acl_options: TypeSafeApiWebAclOptions = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | str | *No description.* |
| cloud_watch_role | bool | Automatically configure an AWS CloudWatch role for API Gateway. |
| deploy | bool | Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. |
| deploy_options | aws_cdk.aws_apigateway.StageOptions | Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. |
| description | str | A description of the RestApi construct. |
| disable_execute_api_endpoint | bool | Specifies whether clients can invoke the API using the default execute-api endpoint. |
| domain_name | aws_cdk.aws_apigateway.DomainNameOptions | Configure a custom domain name and map it to this API. |
| endpoint_export_name | str | Export name for the CfnOutput containing the API endpoint. |
| endpoint_types | typing.List[aws_cdk.aws_apigateway.EndpointType] | A list of the endpoint types of the API. |
| fail_on_warnings | bool | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. |
| parameters | typing.Mapping[str] | Custom header parameters for the request. |
| policy | aws_cdk.aws_iam.PolicyDocument | A policy document that contains the permissions for this RestApi. |
| rest_api_name | str | A name for the API Gateway RestApi resource. |
| retain_deployments | bool | Retains old deployment resources when the API changes. |
| integrations | typing.Mapping[TypeSafeApiIntegration] | A mapping of API operation to its integration. |
| operation_lookup | typing.Mapping[OperationDetails] | Details about each operation. |
| api_key_options | ApiKeyOptions | Options for API keys. |
| cors_options | aws_cdk.aws_apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. |
| default_authorizer | Authorizer | The default authorizer to use for your api. |
| spec_path | str | Path to the JSON open api spec. |
| min_compression_size | aws_cdk.Size | A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. |
| web_acl_options | TypeSafeApiWebAclOptions | Options for the AWS WAF v2 WebACL associated with the api. |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* str
---
##### `cloud_watch_role`Optional
- *Type:* bool
- *Default:* false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise
Automatically configure an AWS CloudWatch role for API Gateway.
---
##### `deploy`Optional
- *Type:* bool
- *Default:* true
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
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.
---
##### `deploy_options`Optional
- *Type:* aws_cdk.aws_apigateway.StageOptions
- *Default:* Based on defaults of `StageOptions`.
Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
If `deploy` is disabled,
this value cannot be set.
---
##### `description`Optional
- *Type:* str
- *Default:* 'Automatically created by the RestApi construct'
A description of the RestApi construct.
---
##### `disable_execute_api_endpoint`Optional
- *Type:* bool
- *Default:* false
Specifies whether clients can invoke the API using the default execute-api endpoint.
To require that clients use a custom domain name to invoke the
API, disable the default endpoint.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)
---
##### `domain_name`Optional
- *Type:* aws_cdk.aws_apigateway.DomainNameOptions
- *Default:* no domain name is defined, use `addDomainName` or directly define a `DomainName`.
Configure a custom domain name and map it to this API.
---
##### `endpoint_export_name`Optional
- *Type:* str
- *Default:* when no export name is given, output will be created without export
Export name for the CfnOutput containing the API endpoint.
---
##### `endpoint_types`Optional
- *Type:* typing.List[aws_cdk.aws_apigateway.EndpointType]
- *Default:* EndpointType.EDGE
A list of the endpoint types of the API.
Use this property when creating
an API.
---
##### `fail_on_warnings`Optional
- *Type:* bool
- *Default:* false
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
---
##### `parameters`Optional
- *Type:* typing.Mapping[str]
- *Default:* No parameters.
Custom header parameters for the request.
> [https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html)
---
##### `policy`Optional
- *Type:* aws_cdk.aws_iam.PolicyDocument
- *Default:* No policy.
A policy document that contains the permissions for this RestApi.
---
##### `rest_api_name`Optional
- *Type:* str
- *Default:* ID of the RestApi construct.
A name for the API Gateway RestApi resource.
---
##### `retain_deployments`Optional
- *Type:* bool
- *Default:* false
Retains old deployment resources when the API changes.
This allows
manually reverting stages to point to old deployments via the AWS
Console.
---
##### `integrations`Required
- *Type:* typing.Mapping[TypeSafeApiIntegration]
A mapping of API operation to its integration.
---
##### `operation_lookup`Required
- *Type:* typing.Mapping[OperationDetails]
Details about each operation.
---
##### `api_key_options`Optional
- *Type:* ApiKeyOptions
Options for API keys.
---
##### `cors_options`Optional
- *Type:* aws_cdk.aws_apigateway.CorsOptions
Cross Origin Resource Sharing options for the API.
---
##### `default_authorizer`Optional
- *Type:* Authorizer
The default authorizer to use for your api.
When omitted, no default authorizer is used.
Authorizers specified at the integration level will override this for that operation.
---
##### `spec_path`Required
- *Type:* str
Path to the JSON open api spec.
---
##### `min_compression_size`Optional
- *Type:* aws_cdk.Size
- *Default:* Compression is disabled.
A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
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.
---
##### `web_acl_options`Optional
- *Type:* TypeSafeApiWebAclOptions
Options for the AWS WAF v2 WebACL associated with the api.
By default, a Web ACL with the AWS default managed
rule set will be associated with the API. These options may disable or override the defaults.
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| to_string | Returns a string representation of this construct. |
---
##### `to_string`
```python
def to_string() -> str
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| is_construct | Checks if `x` is a construct. |
---
##### `is_construct`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeRestApi.is_construct(
x: typing.Any
)
```
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.
###### `x`Required
- *Type:* typing.Any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| api | aws_cdk.aws_apigateway.SpecRestApi | Underlying API Gateway API construct. |
| extended_api_specification | typing.Any | The OpenAPI specification with applied API gateway extensions. |
| ip_set | aws_cdk.aws_wafv2.CfnIPSet | Reference to the IP set if created. |
| web_acl | aws_cdk.aws_wafv2.CfnWebACL | Reference to the webacl, if created. |
| web_acl_association | aws_cdk.aws_wafv2.CfnWebACLAssociation | Reference to the web acl association if created. |
---
##### `node`Required
```python
node: Node
```
- *Type:* constructs.Node
The tree node.
---
##### `api`Required
```python
api: SpecRestApi
```
- *Type:* aws_cdk.aws_apigateway.SpecRestApi
Underlying API Gateway API construct.
---
##### `extended_api_specification`Required
```python
extended_api_specification: typing.Any
```
- *Type:* typing.Any
The OpenAPI specification with applied API gateway extensions.
---
##### `ip_set`Optional
```python
ip_set: CfnIPSet
```
- *Type:* aws_cdk.aws_wafv2.CfnIPSet
Reference to the IP set if created.
---
##### `web_acl`Optional
```python
web_acl: CfnWebACL
```
- *Type:* aws_cdk.aws_wafv2.CfnWebACL
Reference to the webacl, if created.
---
##### `web_acl_association`Optional
```python
web_acl_association: CfnWebACLAssociation
```
- *Type:* aws_cdk.aws_wafv2.CfnWebACLAssociation
Reference to the web acl association if created.
---
## Structs
### ApiGatewayIntegration
Represents an api gateway integration.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ApiGatewayIntegration(
cache_key_parameters: typing.List[str] = None,
cache_namespace: str = None,
connection_id: str = None,
connection_type: str = None,
content_handling: str = None,
credentials: str = None,
http_method: str = None,
passthrough_behavior: str = None,
request_parameters: typing.Mapping[str] = None,
request_templates: typing.Mapping[str] = None,
responses: typing.Mapping[ApiGatewayIntegrationResponse] = None,
timeout_in_millis: typing.Union[int, float] = None,
tls_config: ApiGatewayIntegrationTlsConfig = None,
type: str = None,
uri: str = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cache_key_parameters | typing.List[str] | A list of request parameters whose values are to be cached. |
| cache_namespace | str | An API-specific tag group of related cached parameters. |
| connection_id | str | The ID of a VpcLink for the private integration. |
| connection_type | str | The integration connection type. |
| content_handling | str | Request payload encoding conversion types. |
| credentials | str | For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. |
| http_method | str | The HTTP method used in the integration request. |
| passthrough_behavior | str | Specifies how a request payload of unmapped content type is passed through the integration request without modification. |
| request_parameters | typing.Mapping[str] | Specifies mappings from method request parameters to integration request parameters. |
| request_templates | typing.Mapping[str] | Mapping templates for a request payload of specified MIME types. |
| responses | typing.Mapping[ApiGatewayIntegrationResponse] | Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses. |
| timeout_in_millis | typing.Union[int, float] | Custom timeout between 50 and 29,000 milliseconds. |
| tls_config | ApiGatewayIntegrationTlsConfig | Specifies the TLS configuration for an integration. |
| type | str | The type of integration with the specified backend. |
| uri | str | The endpoint URI of the backend. |
---
##### `cache_key_parameters`Optional
```python
cache_key_parameters: typing.List[str]
```
- *Type:* typing.List[str]
A list of request parameters whose values are to be cached.
---
##### `cache_namespace`Optional
```python
cache_namespace: str
```
- *Type:* str
An API-specific tag group of related cached parameters.
---
##### `connection_id`Optional
```python
connection_id: str
```
- *Type:* str
The ID of a VpcLink for the private integration.
> [https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html](https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html)
---
##### `connection_type`Optional
```python
connection_type: str
```
- *Type:* str
The integration connection type.
The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise.
---
##### `content_handling`Optional
```python
content_handling: str
```
- *Type:* str
Request payload encoding conversion types.
Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload
into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text
payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a
base64-decoded blob or passing through a binary payload natively without modification.
---
##### `credentials`Optional
```python
credentials: str
```
- *Type:* str
For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role.
If unspecified, credentials default
to resource-based permissions that must be added manually to allow the API to access the resource. For more
information, see Granting Permissions Using a Resource Policy.
Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this
API is deployed for best performance.
---
##### `http_method`Optional
```python
http_method: str
```
- *Type:* str
The HTTP method used in the integration request.
For Lambda function invocations, the value must be POST.
---
##### `passthrough_behavior`Optional
```python
passthrough_behavior: str
```
- *Type:* str
Specifies how a request payload of unmapped content type is passed through the integration request without modification.
Supported values are when_no_templates, when_no_match, and never.
> [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior)
---
##### `request_parameters`Optional
```python
request_parameters: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Specifies mappings from method request parameters to integration request parameters.
Supported request parameters
are querystring, path, header, and body.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html)
---
##### `request_templates`Optional
```python
request_templates: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Mapping templates for a request payload of specified MIME types.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html)
---
##### `responses`Optional
```python
responses: typing.Mapping[ApiGatewayIntegrationResponse]
```
- *Type:* typing.Mapping[ApiGatewayIntegrationResponse]
Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html)
---
##### `timeout_in_millis`Optional
```python
timeout_in_millis: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
Custom timeout between 50 and 29,000 milliseconds.
The default value is 29,000 milliseconds or 29 seconds.
---
##### `tls_config`Optional
```python
tls_config: ApiGatewayIntegrationTlsConfig
```
- *Type:* ApiGatewayIntegrationTlsConfig
Specifies the TLS configuration for an integration.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html)
---
##### `type`Optional
```python
type: str
```
- *Type:* str
The type of integration with the specified backend.
> [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type)
---
##### `uri`Optional
```python
uri: str
```
- *Type:* str
The endpoint URI of the backend.
For integrations of the aws type, this is an ARN value.
For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme.
---
### ApiGatewayIntegrationResponse
API Gateway integration response.
> [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ApiGatewayIntegrationResponse(
response_parameters: typing.Mapping[str],
response_templates: typing.Mapping[str],
status_code: str,
content_handling: str = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| response_parameters | typing.Mapping[str] | Specifies parameter mappings for the response. |
| response_templates | typing.Mapping[str] | Specifies MIME type-specific mapping templates for the response’s payload. |
| status_code | str | HTTP status code for the method response. |
| content_handling | str | Response payload encoding conversion types. |
---
##### `response_parameters`Required
```python
response_parameters: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Specifies parameter mappings for the response.
---
##### `response_templates`Required
```python
response_templates: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Specifies MIME type-specific mapping templates for the response’s payload.
---
##### `status_code`Required
```python
status_code: str
```
- *Type:* str
HTTP status code for the method response.
---
##### `content_handling`Optional
```python
content_handling: str
```
- *Type:* str
Response payload encoding conversion types.
Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload
into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text
payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a
base64-decoded blob or passing through a binary payload natively without modification.
---
### ApiGatewayIntegrationTlsConfig
Specifies the TLS configuration for an integration.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ApiGatewayIntegrationTlsConfig(
insecure_skip_verification: bool = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| insecure_skip_verification | bool | Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. |
---
##### `insecure_skip_verification`Optional
```python
insecure_skip_verification: bool
```
- *Type:* bool
Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority.
This isn’t recommended, but it enables you to use certificates that are
signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still
performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and
presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.
---
### ApiKeyOptions
Options for API keys.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ApiKeyOptions(
source: ApiKeySourceType,
required_by_default: bool = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| source | aws_cdk.aws_apigateway.ApiKeySourceType | Source type for an API key. |
| required_by_default | bool | Set to true to require an API key on all operations by default. |
---
##### `source`Required
```python
source: ApiKeySourceType
```
- *Type:* aws_cdk.aws_apigateway.ApiKeySourceType
Source type for an API key.
---
##### `required_by_default`Optional
```python
required_by_default: bool
```
- *Type:* bool
Set to true to require an API key on all operations by default.
Only applicable when the source is HEADER.
---
### AuthorizerProps
Properties for an authorizer.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.AuthorizerProps(
authorization_type: AuthorizationType,
authorizer_id: str,
authorization_scopes: typing.List[str] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
### CidrAllowList
Representation of a CIDR range.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CidrAllowList(
cidr_ranges: typing.List[str],
cidr_type: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cidr_ranges | typing.List[str] | Specify an IPv4 address by using CIDR notation. |
| cidr_type | str | Type of CIDR range. |
---
##### `cidr_ranges`Required
```python
cidr_ranges: typing.List[str]
```
- *Type:* typing.List[str]
Specify an IPv4 address by using CIDR notation.
For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32 .
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .
Specify an IPv6 address by using CIDR notation. For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
---
##### `cidr_type`Required
```python
cidr_type: str
```
- *Type:* str
Type of CIDR range.
---
### CodeGenerationSourceOptions
Options for the source files used for code generation.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CodeGenerationSourceOptions(
spec_path: str,
smithy_json_model_path: str = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| spec_path | str | Path to the OpenAPI specification. |
| smithy_json_model_path | str | Path to the Smithy json model if applicable. |
---
##### `spec_path`Required
```python
spec_path: str
```
- *Type:* str
Path to the OpenAPI specification.
---
##### `smithy_json_model_path`Optional
```python
smithy_json_model_path: str
```
- *Type:* str
Path to the Smithy json model if applicable.
---
### CognitoAuthorizerProps
Properties used to configure a cognito authorizer.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CognitoAuthorizerProps(
authorizer_id: str,
user_pools: typing.List[IUserPool],
authorization_scopes: typing.List[str] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorizer_id | str | Unique identifier for this authorizer. |
| user_pools | typing.List[aws_cdk.aws_cognito.IUserPool] | The Cognito user pools associated with this authorizer. |
| authorization_scopes | typing.List[str] | A list of authorization scopes configured on the method. |
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
Unique identifier for this authorizer.
---
##### `user_pools`Required
```python
user_pools: typing.List[IUserPool]
```
- *Type:* typing.List[aws_cdk.aws_cognito.IUserPool]
The Cognito user pools associated with this authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
A list of authorization scopes configured on the method.
When used as the default authorizer, these scopes will be
applied to all methods without an authorizer at the integration level.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes)
---
### CustomAuthorizerProps
Properties used to configure a custom authorizer.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CustomAuthorizerProps(
authorizer_id: str,
function: IFunction,
authorizer_result_ttl_in_seconds: typing.Union[int, float] = None,
identity_source: str = None,
type: CustomAuthorizerType = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorizer_id | str | Unique identifier for this authorizer. |
| function | aws_cdk.aws_lambda.IFunction | The lambda function used to authorize requests. |
| authorizer_result_ttl_in_seconds | typing.Union[int, float] | The number of seconds during which the authorizer result is cached. |
| identity_source | str | The source of the identity in an incoming request. |
| type | CustomAuthorizerType | The type of custom authorizer. |
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
Unique identifier for this authorizer.
---
##### `function`Required
```python
function: IFunction
```
- *Type:* aws_cdk.aws_lambda.IFunction
The lambda function used to authorize requests.
---
##### `authorizer_result_ttl_in_seconds`Optional
```python
authorizer_result_ttl_in_seconds: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* 300
The number of seconds during which the authorizer result is cached.
---
##### `identity_source`Optional
```python
identity_source: str
```
- *Type:* str
- *Default:* "method.request.header.Authorization"
The source of the identity in an incoming request.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource)
---
##### `type`Optional
```python
type: CustomAuthorizerType
```
- *Type:* CustomAuthorizerType
- *Default:* CustomAuthorizerType.TOKEN
The type of custom authorizer.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type)
---
### DocumentationConfiguration
Configuration for generated documentation.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.DocumentationConfiguration(
formats: typing.List[DocumentationFormat],
options: GeneratedDocumentationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| formats | typing.List[DocumentationFormat] | Formats for generated documentation. |
| options | GeneratedDocumentationOptions | Options for the generated documentation projects. |
---
##### `formats`Required
```python
formats: typing.List[DocumentationFormat]
```
- *Type:* typing.List[DocumentationFormat]
Formats for generated documentation.
---
##### `options`Optional
```python
options: GeneratedDocumentationOptions
```
- *Type:* GeneratedDocumentationOptions
Options for the generated documentation projects.
Note that only those provided for the specified formats will apply
---
### GeneratedCodeProjects
Generated code projects.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedCodeProjects(
java: JavaProject = None,
python: PythonProject = None,
typescript: TypeScriptProject = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| java | projen.java.JavaProject | Generated java project. |
| python | projen.python.PythonProject | Generated python project. |
| typescript | projen.typescript.TypeScriptProject | Generated typescript project. |
---
##### `java`Optional
```python
java: JavaProject
```
- *Type:* projen.java.JavaProject
Generated java project.
---
##### `python`Optional
```python
python: PythonProject
```
- *Type:* projen.python.PythonProject
Generated python project.
---
##### `typescript`Optional
```python
typescript: TypeScriptProject
```
- *Type:* projen.typescript.TypeScriptProject
Generated typescript project.
---
### GeneratedDocumentationOptions
Options for generated documentation projects.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedDocumentationOptions(
html2: GeneratedHtml2DocumentationOptions = None,
html_redoc: GeneratedHtmlRedocDocumentationOptions = None,
markdown: GeneratedMarkdownDocumentationOptions = None,
plantuml: GeneratedPlantumlDocumentationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| html2 | GeneratedHtml2DocumentationOptions | Generated html2 documentation project options. |
| html_redoc | GeneratedHtmlRedocDocumentationOptions | Generated html redoc documentation project options. |
| markdown | GeneratedMarkdownDocumentationOptions | Generated markdown documentation project options. |
| plantuml | GeneratedPlantumlDocumentationOptions | Generated plantuml documentation project options. |
---
##### `html2`Optional
```python
html2: GeneratedHtml2DocumentationOptions
```
- *Type:* GeneratedHtml2DocumentationOptions
Generated html2 documentation project options.
---
##### `html_redoc`Optional
```python
html_redoc: GeneratedHtmlRedocDocumentationOptions
```
- *Type:* GeneratedHtmlRedocDocumentationOptions
Generated html redoc documentation project options.
---
##### `markdown`Optional
```python
markdown: GeneratedMarkdownDocumentationOptions
```
- *Type:* GeneratedMarkdownDocumentationOptions
Generated markdown documentation project options.
---
##### `plantuml`Optional
```python
plantuml: GeneratedPlantumlDocumentationOptions
```
- *Type:* GeneratedPlantumlDocumentationOptions
Generated plantuml documentation project options.
---
### GeneratedDocumentationProjects
Generated documentation project references.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedDocumentationProjects(
html2: Project = None,
html_redoc: Project = None,
markdown: Project = None,
plantuml: Project = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| html2 | projen.Project | Generated html2 documentation project. |
| html_redoc | projen.Project | Generated html redoc documentation project. |
| markdown | projen.Project | Generated markdown documentation project. |
| plantuml | projen.Project | Generated plantuml documentation project. |
---
##### `html2`Optional
```python
html2: Project
```
- *Type:* projen.Project
Generated html2 documentation project.
---
##### `html_redoc`Optional
```python
html_redoc: Project
```
- *Type:* projen.Project
Generated html redoc documentation project.
---
##### `markdown`Optional
```python
markdown: Project
```
- *Type:* projen.Project
Generated markdown documentation project.
---
##### `plantuml`Optional
```python
plantuml: Project
```
- *Type:* projen.Project
Generated plantuml documentation project.
---
### GeneratedHandlersCodeOptions
Options for lambda handler projects for implementing API operations.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedHandlersCodeOptions(
java: GeneratedJavaHandlersOptions = None,
python: GeneratedPythonHandlersOptions = None,
typescript: GeneratedTypeScriptHandlersOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| java | GeneratedJavaHandlersOptions | Options for the java handlers project. |
| python | GeneratedPythonHandlersOptions | Options for the python handlers project. |
| typescript | GeneratedTypeScriptHandlersOptions | Options for the typescript handlers project. |
---
##### `java`Optional
```python
java: GeneratedJavaHandlersOptions
```
- *Type:* GeneratedJavaHandlersOptions
Options for the java handlers project.
These override the default inferred options.
---
##### `python`Optional
```python
python: GeneratedPythonHandlersOptions
```
- *Type:* GeneratedPythonHandlersOptions
Options for the python handlers project.
These override the default inferred options.
---
##### `typescript`Optional
```python
typescript: GeneratedTypeScriptHandlersOptions
```
- *Type:* GeneratedTypeScriptHandlersOptions
Options for the typescript handlers project.
These override the default inferred options.
---
### GeneratedHtml2DocumentationOptions
Options for the html2 documentation project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedHtml2DocumentationOptions(
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedHtmlRedocDocumentationOptions
Options for the html redoc documentation project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedHtmlRedocDocumentationOptions(
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedInfrastructureCodeOptions
Options for generated infrastructure.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedInfrastructureCodeOptions(
java: GeneratedJavaInfrastructureOptions = None,
python: GeneratedPythonInfrastructureOptions = None,
typescript: GeneratedTypeScriptInfrastructureOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| java | GeneratedJavaInfrastructureOptions | Options for the generated java infrastructure project. |
| python | GeneratedPythonInfrastructureOptions | Options for the generated python infrastructure project. |
| typescript | GeneratedTypeScriptInfrastructureOptions | Options for the generated typescript infrastructure project. |
---
##### `java`Optional
```python
java: GeneratedJavaInfrastructureOptions
```
- *Type:* GeneratedJavaInfrastructureOptions
Options for the generated java infrastructure project.
These override the default inferred options.
---
##### `python`Optional
```python
python: GeneratedPythonInfrastructureOptions
```
- *Type:* GeneratedPythonInfrastructureOptions
Options for the generated python infrastructure project.
These override the default inferred options.
---
##### `typescript`Optional
```python
typescript: GeneratedTypeScriptInfrastructureOptions
```
- *Type:* GeneratedTypeScriptInfrastructureOptions
Options for the generated typescript infrastructure project.
These override the default inferred options.
---
### GeneratedJavaHandlersOptions
Options for configuring a generated java handlers project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedJavaHandlersOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
artifact_id: str,
group_id: str,
version: str,
description: str = None,
packaging: str = None,
url: str = None,
compile_options: MavenCompileOptions = None,
deps: typing.List[str] = None,
distdir: str = None,
junit: bool = None,
junit_options: JunitOptions = None,
packaging_options: MavenPackagingOptions = None,
projenrc_java: bool = None,
projenrc_java_options: ProjenrcOptions = None,
test_deps: typing.List[str] = None,
sample: bool = None,
sample_java_package: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| artifact_id | str | The artifactId is generally the name that the project is known by. |
| group_id | str | This is generally unique amongst an organization or a project. |
| version | str | This is the last piece of the naming puzzle. |
| description | str | Description of a project is always good. |
| packaging | str | Project packaging format. |
| url | str | The URL, like the name, is not required. |
| compile_options | projen.java.MavenCompileOptions | Compile options. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| distdir | str | Final artifact output directory. |
| junit | bool | Include junit tests. |
| junit_options | projen.java.JunitOptions | junit options. |
| packaging_options | projen.java.MavenPackagingOptions | Packaging options. |
| projenrc_java | bool | Use projenrc in java. |
| projenrc_java_options | projen.java.ProjenrcOptions | Options related to projenrc in java. |
| test_deps | typing.List[str] | List of test dependencies for this project. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| sample_java_package | str | The java package to use for the code sample. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `artifact_id`Required
```python
artifact_id: str
```
- *Type:* str
- *Default:* "my-app"
The artifactId is generally the name that the project is known by.
Although
the groupId is important, people within the group will rarely mention the
groupId in discussion (they are often all be the same ID, such as the
MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId,
creates a key that separates this project from every other project in the
world (at least, it should :) ). Along with the groupId, the artifactId
fully defines the artifact's living quarters within the repository. In the
case of the above project, my-project lives in
$M2_REPO/org/codehaus/mojo/my-project.
---
##### `group_id`Required
```python
group_id: str
```
- *Type:* str
- *Default:* "org.acme"
This is generally unique amongst an organization or a project.
For example,
all core Maven artifacts do (well, should) live under the groupId
org.apache.maven. Group ID's do not necessarily use the dot notation, for
example, the junit project. Note that the dot-notated groupId does not have
to correspond to the package structure that the project contains. It is,
however, a good practice to follow. When stored within a repository, the
group acts much like the Java packaging structure does in an operating
system. The dots are replaced by OS specific directory separators (such as
'/' in Unix) which becomes a relative directory structure from the base
repository. In the example given, the org.codehaus.mojo group lives within
the directory $M2_REPO/org/codehaus/mojo.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
This is the last piece of the naming puzzle.
groupId:artifactId denotes a
single project but they cannot delineate which incarnation of that project
we are talking about. Do we want the junit:junit of 2018 (version 4.12), or
of 2007 (version 3.8.2)? In short: code changes, those changes should be
versioned, and this element keeps those versions in line. It is also used
within an artifact's repository to separate versions from each other.
my-project version 1.0 files live in the directory structure
$M2_REPO/org/codehaus/mojo/my-project/1.0.
---
##### `description`Optional
```python
description: str
```
- *Type:* str
- *Default:* undefined
Description of a project is always good.
Although this should not replace
formal documentation, a quick comment to any readers of the POM is always
helpful.
---
##### `packaging`Optional
```python
packaging: str
```
- *Type:* str
- *Default:* "jar"
Project packaging format.
---
##### `url`Optional
```python
url: str
```
- *Type:* str
- *Default:* undefined
The URL, like the name, is not required.
This is a nice gesture for
projects users, however, so that they know where the project lives.
---
##### `compile_options`Optional
```python
compile_options: MavenCompileOptions
```
- *Type:* projen.java.MavenCompileOptions
- *Default:* defaults
Compile options.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `distdir`Optional
```python
distdir: str
```
- *Type:* str
- *Default:* "dist/java"
Final artifact output directory.
---
##### `junit`Optional
```python
junit: bool
```
- *Type:* bool
- *Default:* true
Include junit tests.
---
##### `junit_options`Optional
```python
junit_options: JunitOptions
```
- *Type:* projen.java.JunitOptions
- *Default:* defaults
junit options.
---
##### `packaging_options`Optional
```python
packaging_options: MavenPackagingOptions
```
- *Type:* projen.java.MavenPackagingOptions
- *Default:* defaults
Packaging options.
---
##### `projenrc_java`Optional
```python
projenrc_java: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in java.
This will install `projen` as a java dependency and will add a `synth` task which
will compile & execute `main()` from `src/main/java/projenrc.java`.
---
##### `projenrc_java_options`Optional
```python
projenrc_java_options: ProjenrcOptions
```
- *Type:* projen.java.ProjenrcOptions
- *Default:* default options
Options related to projenrc in java.
---
##### `test_deps`Optional
```python
test_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of test dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addTestDependency()`.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `sample_java_package`Optional
```python
sample_java_package: str
```
- *Type:* str
- *Default:* "org.acme"
The java package to use for the code sample.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedJavaInfrastructureOptions
Options for configuring a generated java infrastructure project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedJavaInfrastructureOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
artifact_id: str,
group_id: str,
version: str,
description: str = None,
packaging: str = None,
url: str = None,
compile_options: MavenCompileOptions = None,
deps: typing.List[str] = None,
distdir: str = None,
junit: bool = None,
junit_options: JunitOptions = None,
packaging_options: MavenPackagingOptions = None,
projenrc_java: bool = None,
projenrc_java_options: ProjenrcOptions = None,
test_deps: typing.List[str] = None,
sample: bool = None,
sample_java_package: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None,
mock_data_options: MockResponseDataGenerationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| artifact_id | str | The artifactId is generally the name that the project is known by. |
| group_id | str | This is generally unique amongst an organization or a project. |
| version | str | This is the last piece of the naming puzzle. |
| description | str | Description of a project is always good. |
| packaging | str | Project packaging format. |
| url | str | The URL, like the name, is not required. |
| compile_options | projen.java.MavenCompileOptions | Compile options. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| distdir | str | Final artifact output directory. |
| junit | bool | Include junit tests. |
| junit_options | projen.java.JunitOptions | junit options. |
| packaging_options | projen.java.MavenPackagingOptions | Packaging options. |
| projenrc_java | bool | Use projenrc in java. |
| projenrc_java_options | projen.java.ProjenrcOptions | Options related to projenrc in java. |
| test_deps | typing.List[str] | List of test dependencies for this project. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| sample_java_package | str | The java package to use for the code sample. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
| mock_data_options | MockResponseDataGenerationOptions | Options for the generated mock response data. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `artifact_id`Required
```python
artifact_id: str
```
- *Type:* str
- *Default:* "my-app"
The artifactId is generally the name that the project is known by.
Although
the groupId is important, people within the group will rarely mention the
groupId in discussion (they are often all be the same ID, such as the
MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId,
creates a key that separates this project from every other project in the
world (at least, it should :) ). Along with the groupId, the artifactId
fully defines the artifact's living quarters within the repository. In the
case of the above project, my-project lives in
$M2_REPO/org/codehaus/mojo/my-project.
---
##### `group_id`Required
```python
group_id: str
```
- *Type:* str
- *Default:* "org.acme"
This is generally unique amongst an organization or a project.
For example,
all core Maven artifacts do (well, should) live under the groupId
org.apache.maven. Group ID's do not necessarily use the dot notation, for
example, the junit project. Note that the dot-notated groupId does not have
to correspond to the package structure that the project contains. It is,
however, a good practice to follow. When stored within a repository, the
group acts much like the Java packaging structure does in an operating
system. The dots are replaced by OS specific directory separators (such as
'/' in Unix) which becomes a relative directory structure from the base
repository. In the example given, the org.codehaus.mojo group lives within
the directory $M2_REPO/org/codehaus/mojo.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
This is the last piece of the naming puzzle.
groupId:artifactId denotes a
single project but they cannot delineate which incarnation of that project
we are talking about. Do we want the junit:junit of 2018 (version 4.12), or
of 2007 (version 3.8.2)? In short: code changes, those changes should be
versioned, and this element keeps those versions in line. It is also used
within an artifact's repository to separate versions from each other.
my-project version 1.0 files live in the directory structure
$M2_REPO/org/codehaus/mojo/my-project/1.0.
---
##### `description`Optional
```python
description: str
```
- *Type:* str
- *Default:* undefined
Description of a project is always good.
Although this should not replace
formal documentation, a quick comment to any readers of the POM is always
helpful.
---
##### `packaging`Optional
```python
packaging: str
```
- *Type:* str
- *Default:* "jar"
Project packaging format.
---
##### `url`Optional
```python
url: str
```
- *Type:* str
- *Default:* undefined
The URL, like the name, is not required.
This is a nice gesture for
projects users, however, so that they know where the project lives.
---
##### `compile_options`Optional
```python
compile_options: MavenCompileOptions
```
- *Type:* projen.java.MavenCompileOptions
- *Default:* defaults
Compile options.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `distdir`Optional
```python
distdir: str
```
- *Type:* str
- *Default:* "dist/java"
Final artifact output directory.
---
##### `junit`Optional
```python
junit: bool
```
- *Type:* bool
- *Default:* true
Include junit tests.
---
##### `junit_options`Optional
```python
junit_options: JunitOptions
```
- *Type:* projen.java.JunitOptions
- *Default:* defaults
junit options.
---
##### `packaging_options`Optional
```python
packaging_options: MavenPackagingOptions
```
- *Type:* projen.java.MavenPackagingOptions
- *Default:* defaults
Packaging options.
---
##### `projenrc_java`Optional
```python
projenrc_java: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in java.
This will install `projen` as a java dependency and will add a `synth` task which
will compile & execute `main()` from `src/main/java/projenrc.java`.
---
##### `projenrc_java_options`Optional
```python
projenrc_java_options: ProjenrcOptions
```
- *Type:* projen.java.ProjenrcOptions
- *Default:* default options
Options related to projenrc in java.
---
##### `test_deps`Optional
```python
test_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of test dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addTestDependency()`.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `sample_java_package`Optional
```python
sample_java_package: str
```
- *Type:* str
- *Default:* "org.acme"
The java package to use for the code sample.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
##### `mock_data_options`Optional
```python
mock_data_options: MockResponseDataGenerationOptions
```
- *Type:* MockResponseDataGenerationOptions
Options for the generated mock response data.
---
### GeneratedJavaRuntimeOptions
Options for configuring a generated java runtime project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedJavaRuntimeOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
artifact_id: str,
group_id: str,
version: str,
description: str = None,
packaging: str = None,
url: str = None,
compile_options: MavenCompileOptions = None,
deps: typing.List[str] = None,
distdir: str = None,
junit: bool = None,
junit_options: JunitOptions = None,
packaging_options: MavenPackagingOptions = None,
projenrc_java: bool = None,
projenrc_java_options: ProjenrcOptions = None,
test_deps: typing.List[str] = None,
sample: bool = None,
sample_java_package: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| artifact_id | str | The artifactId is generally the name that the project is known by. |
| group_id | str | This is generally unique amongst an organization or a project. |
| version | str | This is the last piece of the naming puzzle. |
| description | str | Description of a project is always good. |
| packaging | str | Project packaging format. |
| url | str | The URL, like the name, is not required. |
| compile_options | projen.java.MavenCompileOptions | Compile options. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| distdir | str | Final artifact output directory. |
| junit | bool | Include junit tests. |
| junit_options | projen.java.JunitOptions | junit options. |
| packaging_options | projen.java.MavenPackagingOptions | Packaging options. |
| projenrc_java | bool | Use projenrc in java. |
| projenrc_java_options | projen.java.ProjenrcOptions | Options related to projenrc in java. |
| test_deps | typing.List[str] | List of test dependencies for this project. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| sample_java_package | str | The java package to use for the code sample. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `artifact_id`Required
```python
artifact_id: str
```
- *Type:* str
- *Default:* "my-app"
The artifactId is generally the name that the project is known by.
Although
the groupId is important, people within the group will rarely mention the
groupId in discussion (they are often all be the same ID, such as the
MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId,
creates a key that separates this project from every other project in the
world (at least, it should :) ). Along with the groupId, the artifactId
fully defines the artifact's living quarters within the repository. In the
case of the above project, my-project lives in
$M2_REPO/org/codehaus/mojo/my-project.
---
##### `group_id`Required
```python
group_id: str
```
- *Type:* str
- *Default:* "org.acme"
This is generally unique amongst an organization or a project.
For example,
all core Maven artifacts do (well, should) live under the groupId
org.apache.maven. Group ID's do not necessarily use the dot notation, for
example, the junit project. Note that the dot-notated groupId does not have
to correspond to the package structure that the project contains. It is,
however, a good practice to follow. When stored within a repository, the
group acts much like the Java packaging structure does in an operating
system. The dots are replaced by OS specific directory separators (such as
'/' in Unix) which becomes a relative directory structure from the base
repository. In the example given, the org.codehaus.mojo group lives within
the directory $M2_REPO/org/codehaus/mojo.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
This is the last piece of the naming puzzle.
groupId:artifactId denotes a
single project but they cannot delineate which incarnation of that project
we are talking about. Do we want the junit:junit of 2018 (version 4.12), or
of 2007 (version 3.8.2)? In short: code changes, those changes should be
versioned, and this element keeps those versions in line. It is also used
within an artifact's repository to separate versions from each other.
my-project version 1.0 files live in the directory structure
$M2_REPO/org/codehaus/mojo/my-project/1.0.
---
##### `description`Optional
```python
description: str
```
- *Type:* str
- *Default:* undefined
Description of a project is always good.
Although this should not replace
formal documentation, a quick comment to any readers of the POM is always
helpful.
---
##### `packaging`Optional
```python
packaging: str
```
- *Type:* str
- *Default:* "jar"
Project packaging format.
---
##### `url`Optional
```python
url: str
```
- *Type:* str
- *Default:* undefined
The URL, like the name, is not required.
This is a nice gesture for
projects users, however, so that they know where the project lives.
---
##### `compile_options`Optional
```python
compile_options: MavenCompileOptions
```
- *Type:* projen.java.MavenCompileOptions
- *Default:* defaults
Compile options.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `distdir`Optional
```python
distdir: str
```
- *Type:* str
- *Default:* "dist/java"
Final artifact output directory.
---
##### `junit`Optional
```python
junit: bool
```
- *Type:* bool
- *Default:* true
Include junit tests.
---
##### `junit_options`Optional
```python
junit_options: JunitOptions
```
- *Type:* projen.java.JunitOptions
- *Default:* defaults
junit options.
---
##### `packaging_options`Optional
```python
packaging_options: MavenPackagingOptions
```
- *Type:* projen.java.MavenPackagingOptions
- *Default:* defaults
Packaging options.
---
##### `projenrc_java`Optional
```python
projenrc_java: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in java.
This will install `projen` as a java dependency and will add a `synth` task which
will compile & execute `main()` from `src/main/java/projenrc.java`.
---
##### `projenrc_java_options`Optional
```python
projenrc_java_options: ProjenrcOptions
```
- *Type:* projen.java.ProjenrcOptions
- *Default:* default options
Options related to projenrc in java.
---
##### `test_deps`Optional
```python
test_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of test dependencies for this project.
Dependencies use the format: `/@`
Additional dependencies can be added via `project.addTestDependency()`.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `sample_java_package`Optional
```python
sample_java_package: str
```
- *Type:* str
- *Default:* "org.acme"
The java package to use for the code sample.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedLibraryOptions
Options for generated libraries.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedLibraryOptions(
typescript_react_query_hooks: GeneratedTypeScriptReactQueryHooksOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| typescript_react_query_hooks | GeneratedTypeScriptReactQueryHooksOptions | Options for the generated typescript react-query hooks library. |
---
##### `typescript_react_query_hooks`Optional
```python
typescript_react_query_hooks: GeneratedTypeScriptReactQueryHooksOptions
```
- *Type:* GeneratedTypeScriptReactQueryHooksOptions
Options for the generated typescript react-query hooks library.
These override the default inferred options.
---
### GeneratedLibraryProjects
Generated library projects.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedLibraryProjects(
typescript_react_query_hooks: TypeScriptProject = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| typescript_react_query_hooks | projen.typescript.TypeScriptProject | Generated typescript react-query hooks project. |
---
##### `typescript_react_query_hooks`Optional
```python
typescript_react_query_hooks: TypeScriptProject
```
- *Type:* projen.typescript.TypeScriptProject
Generated typescript react-query hooks project.
---
### GeneratedMarkdownDocumentationOptions
Options for the markdown documentation project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedMarkdownDocumentationOptions(
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedPlantumlDocumentationOptions
Options for the plantuml documentation project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedPlantumlDocumentationOptions(
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedPythonHandlersOptions
Options for configuring a generated python handlers project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedPythonHandlersOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
author_email: str,
author_name: str,
version: str,
classifiers: typing.List[str] = None,
description: str = None,
homepage: str = None,
license: str = None,
package_name: str = None,
poetry_options: PoetryPyprojectOptionsWithoutDeps = None,
setup_config: typing.Mapping[typing.Any] = None,
module_name: str,
deps: typing.List[str] = None,
dev_deps: typing.List[str] = None,
pip: bool = None,
poetry: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projenrc_python: bool = None,
projenrc_python_options: ProjenrcOptions = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcTsOptions = None,
pytest: bool = None,
pytest_options: PytestOptions = None,
python_exec: str = None,
sample: bool = None,
setuptools: bool = None,
venv: bool = None,
venv_options: VenvOptions = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| version | str | Version of the package. |
| classifiers | typing.List[str] | A list of PyPI trove classifiers that describe the project. |
| description | str | A short description of the package. |
| homepage | str | A URL to the website of the project. |
| license | str | License of this package as an SPDX identifier. |
| package_name | str | Package name. |
| poetry_options | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. |
| setup_config | typing.Mapping[typing.Any] | Additional fields to pass in the setup() function if using setuptools. |
| module_name | str | Name of the python package as used in imports and filenames. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| dev_deps | typing.List[str] | List of dev dependencies for this project. |
| pip | bool | Use pip with a requirements.txt file to track project dependencies. |
| poetry | bool | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. |
| projenrc_js | bool | Use projenrc in javascript. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. |
| projenrc_python | bool | Use projenrc in Python. |
| projenrc_python_options | projen.python.ProjenrcOptions | Options related to projenrc in python. |
| projenrc_ts | bool | Use projenrc in TypeScript. |
| projenrc_ts_options | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. |
| pytest | bool | Include pytest tests. |
| pytest_options | projen.python.PytestOptions | pytest options. |
| python_exec | str | Path to the python executable to use. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| setuptools | bool | Use setuptools with a setup.py script for packaging and publishing. |
| venv | bool | Use venv to manage a virtual environment for installing dependencies inside. |
| venv_options | projen.python.VenvOptions | Venv options. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `author_email`Required
```python
author_email: str
```
- *Type:* str
- *Default:* $GIT_USER_EMAIL
Author's e-mail.
---
##### `author_name`Required
```python
author_name: str
```
- *Type:* str
- *Default:* $GIT_USER_NAME
Author's name.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
Version of the package.
---
##### `classifiers`Optional
```python
classifiers: typing.List[str]
```
- *Type:* typing.List[str]
A list of PyPI trove classifiers that describe the project.
> [https://pypi.org/classifiers/](https://pypi.org/classifiers/)
---
##### `description`Optional
```python
description: str
```
- *Type:* str
A short description of the package.
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
A URL to the website of the project.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
License of this package as an SPDX identifier.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
Package name.
---
##### `poetry_options`Optional
```python
poetry_options: PoetryPyprojectOptionsWithoutDeps
```
- *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps
Additional options to set for poetry if using poetry.
---
##### `setup_config`Optional
```python
setup_config: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
Additional fields to pass in the setup() function if using setuptools.
---
##### `module_name`Required
```python
module_name: str
```
- *Type:* str
- *Default:* $PYTHON_MODULE_NAME
Name of the python package as used in imports and filenames.
Must only consist of alphanumeric characters and underscores.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of dev dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDevDependency()`.
---
##### `pip`Optional
```python
pip: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use pip with a requirements.txt file to track project dependencies.
---
##### `poetry`Optional
```python
poetry: bool
```
- *Type:* bool
- *Default:* false
Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
This feature is incompatible with pip, setuptools, or venv.
If you set this option to `true`, then pip, setuptools, and venv must be set to `false`.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in javascript.
This will install `projen` as a JavaScript dependency and add a `synth`
task which will run `.projenrc.js`.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options related to projenrc in JavaScript.
---
##### `projenrc_python`Optional
```python
projenrc_python: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in Python.
This will install `projen` as a Python dependency and add a `synth`
task which will run `.projenrc.py`.
---
##### `projenrc_python_options`Optional
```python
projenrc_python_options: ProjenrcOptions
```
- *Type:* projen.python.ProjenrcOptions
- *Default:* default options
Options related to projenrc in python.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in TypeScript.
This will create a tsconfig file (default: `tsconfig.projen.json`)
and use `ts-node` in the default task to parse the project source files.
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcTsOptions
```
- *Type:* projen.typescript.ProjenrcTsOptions
- *Default:* default options
Options related to projenrc in TypeScript.
---
##### `pytest`Optional
```python
pytest: bool
```
- *Type:* bool
- *Default:* true
Include pytest tests.
---
##### `pytest_options`Optional
```python
pytest_options: PytestOptions
```
- *Type:* projen.python.PytestOptions
- *Default:* defaults
pytest options.
---
##### `python_exec`Optional
```python
python_exec: str
```
- *Type:* str
- *Default:* "python"
Path to the python executable to use.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `setuptools`Optional
```python
setuptools: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use setuptools with a setup.py script for packaging and publishing.
---
##### `venv`Optional
```python
venv: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use venv to manage a virtual environment for installing dependencies inside.
---
##### `venv_options`Optional
```python
venv_options: VenvOptions
```
- *Type:* projen.python.VenvOptions
- *Default:* defaults
Venv options.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedPythonInfrastructureOptions
Options for configuring a generated python infrastructure project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedPythonInfrastructureOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
author_email: str,
author_name: str,
version: str,
classifiers: typing.List[str] = None,
description: str = None,
homepage: str = None,
license: str = None,
package_name: str = None,
poetry_options: PoetryPyprojectOptionsWithoutDeps = None,
setup_config: typing.Mapping[typing.Any] = None,
module_name: str,
deps: typing.List[str] = None,
dev_deps: typing.List[str] = None,
pip: bool = None,
poetry: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projenrc_python: bool = None,
projenrc_python_options: ProjenrcOptions = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcTsOptions = None,
pytest: bool = None,
pytest_options: PytestOptions = None,
python_exec: str = None,
sample: bool = None,
setuptools: bool = None,
venv: bool = None,
venv_options: VenvOptions = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None,
mock_data_options: MockResponseDataGenerationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| version | str | Version of the package. |
| classifiers | typing.List[str] | A list of PyPI trove classifiers that describe the project. |
| description | str | A short description of the package. |
| homepage | str | A URL to the website of the project. |
| license | str | License of this package as an SPDX identifier. |
| package_name | str | Package name. |
| poetry_options | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. |
| setup_config | typing.Mapping[typing.Any] | Additional fields to pass in the setup() function if using setuptools. |
| module_name | str | Name of the python package as used in imports and filenames. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| dev_deps | typing.List[str] | List of dev dependencies for this project. |
| pip | bool | Use pip with a requirements.txt file to track project dependencies. |
| poetry | bool | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. |
| projenrc_js | bool | Use projenrc in javascript. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. |
| projenrc_python | bool | Use projenrc in Python. |
| projenrc_python_options | projen.python.ProjenrcOptions | Options related to projenrc in python. |
| projenrc_ts | bool | Use projenrc in TypeScript. |
| projenrc_ts_options | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. |
| pytest | bool | Include pytest tests. |
| pytest_options | projen.python.PytestOptions | pytest options. |
| python_exec | str | Path to the python executable to use. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| setuptools | bool | Use setuptools with a setup.py script for packaging and publishing. |
| venv | bool | Use venv to manage a virtual environment for installing dependencies inside. |
| venv_options | projen.python.VenvOptions | Venv options. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
| mock_data_options | MockResponseDataGenerationOptions | Options for the generated mock response data. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `author_email`Required
```python
author_email: str
```
- *Type:* str
- *Default:* $GIT_USER_EMAIL
Author's e-mail.
---
##### `author_name`Required
```python
author_name: str
```
- *Type:* str
- *Default:* $GIT_USER_NAME
Author's name.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
Version of the package.
---
##### `classifiers`Optional
```python
classifiers: typing.List[str]
```
- *Type:* typing.List[str]
A list of PyPI trove classifiers that describe the project.
> [https://pypi.org/classifiers/](https://pypi.org/classifiers/)
---
##### `description`Optional
```python
description: str
```
- *Type:* str
A short description of the package.
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
A URL to the website of the project.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
License of this package as an SPDX identifier.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
Package name.
---
##### `poetry_options`Optional
```python
poetry_options: PoetryPyprojectOptionsWithoutDeps
```
- *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps
Additional options to set for poetry if using poetry.
---
##### `setup_config`Optional
```python
setup_config: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
Additional fields to pass in the setup() function if using setuptools.
---
##### `module_name`Required
```python
module_name: str
```
- *Type:* str
- *Default:* $PYTHON_MODULE_NAME
Name of the python package as used in imports and filenames.
Must only consist of alphanumeric characters and underscores.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of dev dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDevDependency()`.
---
##### `pip`Optional
```python
pip: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use pip with a requirements.txt file to track project dependencies.
---
##### `poetry`Optional
```python
poetry: bool
```
- *Type:* bool
- *Default:* false
Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
This feature is incompatible with pip, setuptools, or venv.
If you set this option to `true`, then pip, setuptools, and venv must be set to `false`.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in javascript.
This will install `projen` as a JavaScript dependency and add a `synth`
task which will run `.projenrc.js`.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options related to projenrc in JavaScript.
---
##### `projenrc_python`Optional
```python
projenrc_python: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in Python.
This will install `projen` as a Python dependency and add a `synth`
task which will run `.projenrc.py`.
---
##### `projenrc_python_options`Optional
```python
projenrc_python_options: ProjenrcOptions
```
- *Type:* projen.python.ProjenrcOptions
- *Default:* default options
Options related to projenrc in python.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in TypeScript.
This will create a tsconfig file (default: `tsconfig.projen.json`)
and use `ts-node` in the default task to parse the project source files.
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcTsOptions
```
- *Type:* projen.typescript.ProjenrcTsOptions
- *Default:* default options
Options related to projenrc in TypeScript.
---
##### `pytest`Optional
```python
pytest: bool
```
- *Type:* bool
- *Default:* true
Include pytest tests.
---
##### `pytest_options`Optional
```python
pytest_options: PytestOptions
```
- *Type:* projen.python.PytestOptions
- *Default:* defaults
pytest options.
---
##### `python_exec`Optional
```python
python_exec: str
```
- *Type:* str
- *Default:* "python"
Path to the python executable to use.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `setuptools`Optional
```python
setuptools: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use setuptools with a setup.py script for packaging and publishing.
---
##### `venv`Optional
```python
venv: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use venv to manage a virtual environment for installing dependencies inside.
---
##### `venv_options`Optional
```python
venv_options: VenvOptions
```
- *Type:* projen.python.VenvOptions
- *Default:* defaults
Venv options.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
##### `mock_data_options`Optional
```python
mock_data_options: MockResponseDataGenerationOptions
```
- *Type:* MockResponseDataGenerationOptions
Options for the generated mock response data.
---
### GeneratedPythonRuntimeOptions
Options for configuring a generated python runtime project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedPythonRuntimeOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
author_email: str,
author_name: str,
version: str,
classifiers: typing.List[str] = None,
description: str = None,
homepage: str = None,
license: str = None,
package_name: str = None,
poetry_options: PoetryPyprojectOptionsWithoutDeps = None,
setup_config: typing.Mapping[typing.Any] = None,
module_name: str,
deps: typing.List[str] = None,
dev_deps: typing.List[str] = None,
pip: bool = None,
poetry: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projenrc_python: bool = None,
projenrc_python_options: ProjenrcOptions = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcTsOptions = None,
pytest: bool = None,
pytest_options: PytestOptions = None,
python_exec: str = None,
sample: bool = None,
setuptools: bool = None,
venv: bool = None,
venv_options: VenvOptions = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| version | str | Version of the package. |
| classifiers | typing.List[str] | A list of PyPI trove classifiers that describe the project. |
| description | str | A short description of the package. |
| homepage | str | A URL to the website of the project. |
| license | str | License of this package as an SPDX identifier. |
| package_name | str | Package name. |
| poetry_options | projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. |
| setup_config | typing.Mapping[typing.Any] | Additional fields to pass in the setup() function if using setuptools. |
| module_name | str | Name of the python package as used in imports and filenames. |
| deps | typing.List[str] | List of runtime dependencies for this project. |
| dev_deps | typing.List[str] | List of dev dependencies for this project. |
| pip | bool | Use pip with a requirements.txt file to track project dependencies. |
| poetry | bool | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. |
| projenrc_js | bool | Use projenrc in javascript. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. |
| projenrc_python | bool | Use projenrc in Python. |
| projenrc_python_options | projen.python.ProjenrcOptions | Options related to projenrc in python. |
| projenrc_ts | bool | Use projenrc in TypeScript. |
| projenrc_ts_options | projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. |
| pytest | bool | Include pytest tests. |
| pytest_options | projen.python.PytestOptions | pytest options. |
| python_exec | str | Path to the python executable to use. |
| sample | bool | Include sample code and test if the relevant directories don't exist. |
| setuptools | bool | Use setuptools with a setup.py script for packaging and publishing. |
| venv | bool | Use venv to manage a virtual environment for installing dependencies inside. |
| venv_options | projen.python.VenvOptions | Venv options. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `author_email`Required
```python
author_email: str
```
- *Type:* str
- *Default:* $GIT_USER_EMAIL
Author's e-mail.
---
##### `author_name`Required
```python
author_name: str
```
- *Type:* str
- *Default:* $GIT_USER_NAME
Author's name.
---
##### `version`Required
```python
version: str
```
- *Type:* str
- *Default:* "0.1.0"
Version of the package.
---
##### `classifiers`Optional
```python
classifiers: typing.List[str]
```
- *Type:* typing.List[str]
A list of PyPI trove classifiers that describe the project.
> [https://pypi.org/classifiers/](https://pypi.org/classifiers/)
---
##### `description`Optional
```python
description: str
```
- *Type:* str
A short description of the package.
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
A URL to the website of the project.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
License of this package as an SPDX identifier.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
Package name.
---
##### `poetry_options`Optional
```python
poetry_options: PoetryPyprojectOptionsWithoutDeps
```
- *Type:* projen.python.PoetryPyprojectOptionsWithoutDeps
Additional options to set for poetry if using poetry.
---
##### `setup_config`Optional
```python
setup_config: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
Additional fields to pass in the setup() function if using setuptools.
---
##### `module_name`Required
```python
module_name: str
```
- *Type:* str
- *Default:* $PYTHON_MODULE_NAME
Name of the python package as used in imports and filenames.
Must only consist of alphanumeric characters and underscores.
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of runtime dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDependency()`.
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
List of dev dependencies for this project.
Dependencies use the format: `@`
Additional dependencies can be added via `project.addDevDependency()`.
---
##### `pip`Optional
```python
pip: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use pip with a requirements.txt file to track project dependencies.
---
##### `poetry`Optional
```python
poetry: bool
```
- *Type:* bool
- *Default:* false
Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
This feature is incompatible with pip, setuptools, or venv.
If you set this option to `true`, then pip, setuptools, and venv must be set to `false`.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in javascript.
This will install `projen` as a JavaScript dependency and add a `synth`
task which will run `.projenrc.js`.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options related to projenrc in JavaScript.
---
##### `projenrc_python`Optional
```python
projenrc_python: bool
```
- *Type:* bool
- *Default:* true
Use projenrc in Python.
This will install `projen` as a Python dependency and add a `synth`
task which will run `.projenrc.py`.
---
##### `projenrc_python_options`Optional
```python
projenrc_python_options: ProjenrcOptions
```
- *Type:* projen.python.ProjenrcOptions
- *Default:* default options
Options related to projenrc in python.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use projenrc in TypeScript.
This will create a tsconfig file (default: `tsconfig.projen.json`)
and use `ts-node` in the default task to parse the project source files.
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcTsOptions
```
- *Type:* projen.typescript.ProjenrcTsOptions
- *Default:* default options
Options related to projenrc in TypeScript.
---
##### `pytest`Optional
```python
pytest: bool
```
- *Type:* bool
- *Default:* true
Include pytest tests.
---
##### `pytest_options`Optional
```python
pytest_options: PytestOptions
```
- *Type:* projen.python.PytestOptions
- *Default:* defaults
pytest options.
---
##### `python_exec`Optional
```python
python_exec: str
```
- *Type:* str
- *Default:* "python"
Path to the python executable to use.
---
##### `sample`Optional
```python
sample: bool
```
- *Type:* bool
- *Default:* true
Include sample code and test if the relevant directories don't exist.
---
##### `setuptools`Optional
```python
setuptools: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use setuptools with a setup.py script for packaging and publishing.
---
##### `venv`Optional
```python
venv: bool
```
- *Type:* bool
- *Default:* true, unless poetry is true, then false
Use venv to manage a virtual environment for installing dependencies inside.
---
##### `venv_options`Optional
```python
venv_options: VenvOptions
```
- *Type:* projen.python.VenvOptions
- *Default:* defaults
Venv options.
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedRuntimeCodeOptions
Options for generated runtimes.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedRuntimeCodeOptions(
java: GeneratedJavaRuntimeOptions = None,
python: GeneratedPythonRuntimeOptions = None,
typescript: GeneratedTypeScriptRuntimeOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| java | GeneratedJavaRuntimeOptions | Options for a generated java project. |
| python | GeneratedPythonRuntimeOptions | Options for a generated python project. |
| typescript | GeneratedTypeScriptRuntimeOptions | Options for a generated typescript project. |
---
##### `java`Optional
```python
java: GeneratedJavaRuntimeOptions
```
- *Type:* GeneratedJavaRuntimeOptions
Options for a generated java project.
These override the default inferred options.
---
##### `python`Optional
```python
python: GeneratedPythonRuntimeOptions
```
- *Type:* GeneratedPythonRuntimeOptions
Options for a generated python project.
These override the default inferred options.
---
##### `typescript`Optional
```python
typescript: GeneratedTypeScriptRuntimeOptions
```
- *Type:* GeneratedTypeScriptRuntimeOptions
Options for a generated typescript project.
These override the default inferred options.
---
### GeneratedTypeScriptHandlersOptions
Options for configuring a generated typescript handlers project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedTypeScriptHandlersOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
allow_library_dependencies: bool = None,
author_email: str = None,
author_name: str = None,
author_organization: bool = None,
author_url: str = None,
auto_detect_bin: bool = None,
bin: typing.Mapping[str] = None,
bugs_email: str = None,
bugs_url: str = None,
bundled_deps: typing.List[str] = None,
code_artifact_options: CodeArtifactOptions = None,
deps: typing.List[str] = None,
description: str = None,
dev_deps: typing.List[str] = None,
entrypoint: str = None,
homepage: str = None,
keywords: typing.List[str] = None,
license: str = None,
licensed: bool = None,
max_node_version: str = None,
min_node_version: str = None,
npm_access: NpmAccess = None,
npm_registry: str = None,
npm_registry_url: str = None,
npm_token_secret: str = None,
package_manager: NodePackageManager = None,
package_name: str = None,
peer_dependency_options: PeerDependencyOptions = None,
peer_deps: typing.List[str] = None,
pnpm_version: str = None,
repository: str = None,
repository_directory: str = None,
scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
scripts: typing.Mapping[str] = None,
stability: str = None,
jsii_release_version: str = None,
major_version: typing.Union[int, float] = None,
min_major_version: typing.Union[int, float] = None,
npm_dist_tag: str = None,
post_build_steps: typing.List[JobStep] = None,
prerelease: str = None,
publish_dry_run: bool = None,
publish_tasks: bool = None,
release_branches: typing.Mapping[BranchOptions] = None,
release_every_commit: bool = None,
release_failure_issue: bool = None,
release_failure_issue_label: str = None,
release_schedule: str = None,
release_tag_prefix: str = None,
release_trigger: ReleaseTrigger = None,
release_workflow_name: str = None,
release_workflow_setup_steps: typing.List[JobStep] = None,
versionrc_options: typing.Mapping[typing.Any] = None,
workflow_container_image: str = None,
workflow_runs_on: typing.List[str] = None,
default_release_branch: str,
artifacts_directory: str = None,
auto_approve_upgrades: bool = None,
build_workflow: bool = None,
build_workflow_triggers: Triggers = None,
bundler_options: BundlerOptions = None,
code_cov: bool = None,
code_cov_token_secret: str = None,
copyright_owner: str = None,
copyright_period: str = None,
dependabot: bool = None,
dependabot_options: DependabotOptions = None,
deps_upgrade: bool = None,
deps_upgrade_options: UpgradeDependenciesOptions = None,
gitignore: typing.List[str] = None,
jest: bool = None,
jest_options: JestOptions = None,
mutable_build: bool = None,
npmignore: typing.List[str] = None,
npmignore_enabled: bool = None,
npm_ignore_options: IgnoreFileOptions = None,
package: bool = None,
prettier: bool = None,
prettier_options: PrettierOptions = None,
projen_dev_dependency: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projen_version: str = None,
pull_request_template: bool = None,
pull_request_template_contents: typing.List[str] = None,
release: bool = None,
release_to_npm: bool = None,
release_workflow: bool = None,
workflow_bootstrap_steps: typing.List[JobStep] = None,
workflow_git_identity: GitIdentity = None,
workflow_node_version: str = None,
workflow_package_cache: bool = None,
disable_tsconfig: bool = None,
disable_tsconfig_dev: bool = None,
docgen: bool = None,
docs_directory: str = None,
entrypoint_types: str = None,
eslint: bool = None,
eslint_options: EslintOptions = None,
libdir: str = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcOptions = None,
sample_code: bool = None,
srcdir: str = None,
testdir: str = None,
tsconfig: TypescriptConfigOptions = None,
tsconfig_dev: TypescriptConfigOptions = None,
tsconfig_dev_file: str = None,
typescript_version: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None,
handler_entry_points: typing.List[str] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| author_organization | bool | Is the author an organization. |
| author_url | str | Author's URL / Website. |
| auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
| bin | typing.Mapping[str] | Binary programs vended with your module. |
| bugs_email | str | The email address to which issues should be reported. |
| bugs_url | str | The url to your project's issue tracker. |
| bundled_deps | typing.List[str] | List of dependencies to bundle into this module. |
| code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. |
| deps | typing.List[str] | Runtime dependencies of this module. |
| description | str | The description is just a string that helps people understand the purpose of the package. |
| dev_deps | typing.List[str] | Build dependencies for this module. |
| entrypoint | str | Module entrypoint (`main` in `package.json`). |
| homepage | str | Package's Homepage / Website. |
| keywords | typing.List[str] | Keywords to include in `package.json`. |
| license | str | License's SPDX identifier. |
| licensed | bool | Indicates if a license should be added. |
| max_node_version | str | Minimum node.js version to require via `engines` (inclusive). |
| min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). |
| npm_access | projen.javascript.NpmAccess | Access level of the npm package. |
| npm_registry | str | The host name of the npm registry to publish to. |
| npm_registry_url | str | The base URL of the npm package registry. |
| npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. |
| package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. |
| package_name | str | The "name" in package.json. |
| peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. |
| peer_deps | typing.List[str] | Peer dependencies for this module. |
| pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. |
| repository | str | The repository is the location where the actual code for your package lives. |
| repository_directory | str | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
| scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. |
| scripts | typing.Mapping[str] | npm scripts to include. |
| stability | str | Package's Stability. |
| jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. |
| major_version | typing.Union[int, float] | Major version to release from the default branch. |
| min_major_version | typing.Union[int, float] | Minimal Major version to release. |
| npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. |
| post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. |
| prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
| publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. |
| publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. |
| release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. |
| release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. |
| release_failure_issue | bool | Create a github issue on every failed publishing task. |
| release_failure_issue_label | str | The label to apply to issues indicating publish failures. |
| release_schedule | str | CRON schedule to trigger new releases. |
| release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
| release_trigger | projen.release.ReleaseTrigger | The release trigger to use. |
| release_workflow_name | str | The name of the default release workflow. |
| release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. |
| versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. |
| workflow_container_image | str | Container image to use for GitHub workflows. |
| workflow_runs_on | typing.List[str] | Github Runner selection labels. |
| default_release_branch | str | The name of the main release branch. |
| artifacts_directory | str | A directory which will contain build artifacts. |
| auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
| build_workflow | bool | Define a GitHub workflow for building PRs. |
| build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. |
| bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. |
| code_cov | bool | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
| code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
| copyright_owner | str | License copyright owner. |
| copyright_period | str | The copyright years to put in the LICENSE file. |
| dependabot | bool | Use dependabot to handle dependency upgrades. |
| dependabot_options | projen.github.DependabotOptions | Options for dependabot. |
| deps_upgrade | bool | Use github workflows to handle dependency upgrades. |
| deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. |
| gitignore | typing.List[str] | Additional entries to .gitignore. |
| jest | bool | Setup jest unit tests. |
| jest_options | projen.javascript.JestOptions | Jest options. |
| mutable_build | bool | Automatically update files modified during builds to pull-request branches. |
| npmignore | typing.List[str] | Additional entries to .npmignore. |
| npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
| npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. |
| package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
| prettier | bool | Setup prettier. |
| prettier_options | projen.javascript.PrettierOptions | Prettier options. |
| projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. |
| projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. |
| projen_version | str | Version of projen to install. |
| pull_request_template | bool | Include a GitHub pull request template. |
| pull_request_template_contents | typing.List[str] | The contents of the pull request template. |
| release | bool | Add release management to this project. |
| release_to_npm | bool | Automatically release to npm when new versions are introduced. |
| release_workflow | bool | DEPRECATED: renamed to `release`. |
| workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. |
| workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. |
| workflow_node_version | str | The node version to use in GitHub workflows. |
| workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. |
| disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
| disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. |
| docgen | bool | Docgen by Typedoc. |
| docs_directory | str | Docs directory. |
| entrypoint_types | str | The .d.ts file that includes the type declarations for this module. |
| eslint | bool | Setup eslint. |
| eslint_options | projen.javascript.EslintOptions | Eslint options. |
| libdir | str | Typescript artifacts output directory. |
| projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). |
| projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. |
| sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. |
| srcdir | str | Typescript sources directory. |
| testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. |
| tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. |
| tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). |
| tsconfig_dev_file | str | The name of the development tsconfig.json file. |
| typescript_version | str | TypeScript version to use. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
| handler_entry_points | typing.List[str] | Globs for lambda handler entry points, used by esbuild. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `allow_library_dependencies`Optional
```python
allow_library_dependencies: bool
```
- *Type:* bool
- *Default:* true
Allow the project to include `peerDependencies` and `bundledDependencies`.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
---
##### `author_email`Optional
```python
author_email: str
```
- *Type:* str
Author's e-mail.
---
##### `author_name`Optional
```python
author_name: str
```
- *Type:* str
Author's name.
---
##### `author_organization`Optional
```python
author_organization: bool
```
- *Type:* bool
Is the author an organization.
---
##### `author_url`Optional
```python
author_url: str
```
- *Type:* str
Author's URL / Website.
---
##### `auto_detect_bin`Optional
```python
auto_detect_bin: bool
```
- *Type:* bool
- *Default:* true
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
---
##### `bin`Optional
```python
bin: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Binary programs vended with your module.
You can use this option to add/customize how binaries are represented in
your `package.json`, but unless `autoDetectBin` is `false`, every
executable file under `bin` will automatically be added to this section.
---
##### `bugs_email`Optional
```python
bugs_email: str
```
- *Type:* str
The email address to which issues should be reported.
---
##### `bugs_url`Optional
```python
bugs_url: str
```
- *Type:* str
The url to your project's issue tracker.
---
##### `bundled_deps`Optional
```python
bundled_deps: typing.List[str]
```
- *Type:* typing.List[str]
List of dependencies to bundle into this module.
These modules will be
added both to the `dependencies` section and `bundledDependencies` section of
your `package.json`.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
##### `code_artifact_options`Optional
```python
code_artifact_options: CodeArtifactOptions
```
- *Type:* projen.javascript.CodeArtifactOptions
- *Default:* undefined
Options for npm packages using AWS CodeArtifact.
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Runtime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'express', 'lodash', 'foo@^2' ]
```
##### `description`Optional
```python
description: str
```
- *Type:* str
The description is just a string that helps people understand the purpose of the package.
It can be used when searching for packages in a package manager as well.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Build dependencies for this module.
These dependencies will only be
available in your build environment but will not be fetched when this
module is consumed.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'typescript', '@types/express' ]
```
##### `entrypoint`Optional
```python
entrypoint: str
```
- *Type:* str
- *Default:* "lib/index.js"
Module entrypoint (`main` in `package.json`).
Set to an empty string to not include `main` in your package.json
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
Package's Homepage / Website.
---
##### `keywords`Optional
```python
keywords: typing.List[str]
```
- *Type:* typing.List[str]
Keywords to include in `package.json`.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
- *Default:* "Apache-2.0"
License's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the `licensed` option if you want to no license to be specified.
---
##### `licensed`Optional
```python
licensed: bool
```
- *Type:* bool
- *Default:* true
Indicates if a license should be added.
---
##### `max_node_version`Optional
```python
max_node_version: str
```
- *Type:* str
- *Default:* no max
Minimum node.js version to require via `engines` (inclusive).
---
##### `min_node_version`Optional
```python
min_node_version: str
```
- *Type:* str
- *Default:* no "engines" specified
Minimum Node.js version to require via package.json `engines` (inclusive).
---
##### `npm_access`Optional
```python
npm_access: NpmAccess
```
- *Type:* projen.javascript.NpmAccess
- *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
Access level of the npm package.
---
##### ~~`npm_registry`~~Optional
- *Deprecated:* use `npmRegistryUrl` instead
```python
npm_registry: str
```
- *Type:* str
The host name of the npm registry to publish to.
Cannot be set together with `npmRegistryUrl`.
---
##### `npm_registry_url`Optional
```python
npm_registry_url: str
```
- *Type:* str
- *Default:* "https://registry.npmjs.org"
The base URL of the npm package registry.
Must be a URL (e.g. start with "https://" or "http://")
---
##### `npm_token_secret`Optional
```python
npm_token_secret: str
```
- *Type:* str
- *Default:* "NPM_TOKEN"
GitHub secret which contains the NPM token to use when publishing packages.
---
##### `package_manager`Optional
```python
package_manager: NodePackageManager
```
- *Type:* projen.javascript.NodePackageManager
- *Default:* NodePackageManager.YARN
The Node Package Manager used to execute scripts.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
- *Default:* defaults to project name
The "name" in package.json.
---
##### `peer_dependency_options`Optional
```python
peer_dependency_options: PeerDependencyOptions
```
- *Type:* projen.javascript.PeerDependencyOptions
Options for `peerDeps`.
---
##### `peer_deps`Optional
```python
peer_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Peer dependencies for this module.
Dependencies listed here are required to
be installed (and satisfied) by the _consumer_ of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the `node_modules` tree of your consumers.
Note that prior to npm@7, peer dependencies are _not_ automatically
installed, which means that adding peer dependencies to a library will be a
breaking change for your customers.
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
---
##### `pnpm_version`Optional
```python
pnpm_version: str
```
- *Type:* str
- *Default:* "7"
The version of PNPM to use if using PNPM as a package manager.
---
##### `repository`Optional
```python
repository: str
```
- *Type:* str
The repository is the location where the actual code for your package lives.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
---
##### `repository_directory`Optional
```python
repository_directory: str
```
- *Type:* str
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
---
##### `scoped_packages_options`Optional
```python
scoped_packages_options: typing.List[ScopedPackagesOptions]
```
- *Type:* typing.List[projen.javascript.ScopedPackagesOptions]
- *Default:* fetch all scoped packages from the public npm registry
Options for privately hosted scoped packages.
---
##### ~~`scripts`~~Optional
- *Deprecated:* use `project.addTask()` or `package.setScript()`
```python
scripts: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
- *Default:* {}
npm scripts to include.
If a script has the same name as a standard script,
the standard script will be overwritten.
Also adds the script as a task.
---
##### `stability`Optional
```python
stability: str
```
- *Type:* str
Package's Stability.
---
##### `jsii_release_version`Optional
```python
jsii_release_version: str
```
- *Type:* str
- *Default:* "latest"
Version requirement of `publib` which is used to publish modules to npm.
---
##### `major_version`Optional
```python
major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* Major version is not enforced.
Major version to release from the default branch.
If this is specified, we bump the latest version of this major version line.
If not specified, we bump the global latest version.
---
##### `min_major_version`Optional
```python
min_major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* No minimum version is being enforced
Minimal Major version to release.
This can be useful to set to 1, as breaking changes before the 1.x major
release are not incrementing the major version number.
Can not be set together with `majorVersion`.
---
##### `npm_dist_tag`Optional
```python
npm_dist_tag: str
```
- *Type:* str
- *Default:* "latest"
The npmDistTag to use when publishing from the default branch.
To set the npm dist-tag for release branches, set the `npmDistTag` property
for each branch.
---
##### `post_build_steps`Optional
```python
post_build_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* []
Steps to execute after build as part of the release workflow.
---
##### `prerelease`Optional
```python
prerelease: str
```
- *Type:* str
- *Default:* normal semantic versions
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
---
##### `publish_dry_run`Optional
```python
publish_dry_run: bool
```
- *Type:* bool
- *Default:* false
Instead of actually publishing to package managers, just print the publishing command.
---
##### `publish_tasks`Optional
```python
publish_tasks: bool
```
- *Type:* bool
- *Default:* false
Define publishing tasks that can be executed manually as well as workflows.
Normally, publishing only happens within automated workflows. Enable this
in order to create a publishing task for each publishing activity.
---
##### `release_branches`Optional
```python
release_branches: typing.Mapping[BranchOptions]
```
- *Type:* typing.Mapping[projen.release.BranchOptions]
- *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
Defines additional release branches.
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch _must_ be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the `majorVersion` field must also
be provided for the default branch.
---
##### ~~`release_every_commit`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
```python
release_every_commit: bool
```
- *Type:* bool
- *Default:* true
Automatically release new versions every commit to one of branches in `releaseBranches`.
---
##### `release_failure_issue`Optional
```python
release_failure_issue: bool
```
- *Type:* bool
- *Default:* false
Create a github issue on every failed publishing task.
---
##### `release_failure_issue_label`Optional
```python
release_failure_issue_label: str
```
- *Type:* str
- *Default:* "failed-release"
The label to apply to issues indicating publish failures.
Only applies if `releaseFailureIssue` is true.
---
##### ~~`release_schedule`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
```python
release_schedule: str
```
- *Type:* str
- *Default:* no scheduled releases
CRON schedule to trigger new releases.
---
##### `release_tag_prefix`Optional
```python
release_tag_prefix: str
```
- *Type:* str
- *Default:* "v"
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
Note: this prefix is used to detect the latest tagged version
when bumping, so if you change this on a project with an existing version
history, you may need to manually tag your latest release
with the new prefix.
---
##### `release_trigger`Optional
```python
release_trigger: ReleaseTrigger
```
- *Type:* projen.release.ReleaseTrigger
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
The release trigger to use.
---
##### `release_workflow_name`Optional
```python
release_workflow_name: str
```
- *Type:* str
- *Default:* "Release"
The name of the default release workflow.
---
##### `release_workflow_setup_steps`Optional
```python
release_workflow_setup_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
A set of workflow steps to execute in order to setup the workflow container.
---
##### `versionrc_options`Optional
```python
versionrc_options: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
- *Default:* standard configuration applicable for GitHub repositories
Custom configuration used when creating changelog with standard-version package.
Given values either append to default configuration or overwrite values in it.
---
##### `workflow_container_image`Optional
```python
workflow_container_image: str
```
- *Type:* str
- *Default:* default image
Container image to use for GitHub workflows.
---
##### `workflow_runs_on`Optional
```python
workflow_runs_on: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* ["ubuntu-latest"]
Github Runner selection labels.
---
##### `default_release_branch`Required
```python
default_release_branch: str
```
- *Type:* str
- *Default:* "main"
The name of the main release branch.
---
##### `artifacts_directory`Optional
```python
artifacts_directory: str
```
- *Type:* str
- *Default:* "dist"
A directory which will contain build artifacts.
---
##### `auto_approve_upgrades`Optional
```python
auto_approve_upgrades: bool
```
- *Type:* bool
- *Default:* true
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but `autoApproveOptions` are not defined.
---
##### `build_workflow`Optional
```python
build_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
Define a GitHub workflow for building PRs.
---
##### `build_workflow_triggers`Optional
```python
build_workflow_triggers: Triggers
```
- *Type:* projen.github.workflows.Triggers
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
Build workflow triggers.
---
##### `bundler_options`Optional
```python
bundler_options: BundlerOptions
```
- *Type:* projen.javascript.BundlerOptions
Options for `Bundler`.
---
##### `code_cov`Optional
```python
code_cov: bool
```
- *Type:* bool
- *Default:* false
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
---
##### `code_cov_token_secret`Optional
```python
code_cov_token_secret: str
```
- *Type:* str
- *Default:* if this option is not specified, only public repositories are supported
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
---
##### `copyright_owner`Optional
```python
copyright_owner: str
```
- *Type:* str
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
License copyright owner.
---
##### `copyright_period`Optional
```python
copyright_period: str
```
- *Type:* str
- *Default:* current year
The copyright years to put in the LICENSE file.
---
##### `dependabot`Optional
```python
dependabot: bool
```
- *Type:* bool
- *Default:* false
Use dependabot to handle dependency upgrades.
Cannot be used in conjunction with `depsUpgrade`.
---
##### `dependabot_options`Optional
```python
dependabot_options: DependabotOptions
```
- *Type:* projen.github.DependabotOptions
- *Default:* default options
Options for dependabot.
---
##### `deps_upgrade`Optional
```python
deps_upgrade: bool
```
- *Type:* bool
- *Default:* true
Use github workflows to handle dependency upgrades.
Cannot be used in conjunction with `dependabot`.
---
##### `deps_upgrade_options`Optional
```python
deps_upgrade_options: UpgradeDependenciesOptions
```
- *Type:* projen.javascript.UpgradeDependenciesOptions
- *Default:* default options
Options for `UpgradeDependencies`.
---
##### `gitignore`Optional
```python
gitignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .gitignore.
---
##### `jest`Optional
```python
jest: bool
```
- *Type:* bool
- *Default:* true
Setup jest unit tests.
---
##### `jest_options`Optional
```python
jest_options: JestOptions
```
- *Type:* projen.javascript.JestOptions
- *Default:* default options
Jest options.
---
##### `mutable_build`Optional
```python
mutable_build: bool
```
- *Type:* bool
- *Default:* true
Automatically update files modified during builds to pull-request branches.
This means
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
---
##### ~~`npmignore`~~Optional
- *Deprecated:* - use `project.addPackageIgnore`
```python
npmignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .npmignore.
---
##### `npmignore_enabled`Optional
```python
npmignore_enabled: bool
```
- *Type:* bool
- *Default:* true
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
---
##### `npm_ignore_options`Optional
```python
npm_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .npmignore file.
---
##### `package`Optional
```python
package: bool
```
- *Type:* bool
- *Default:* true
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
---
##### `prettier`Optional
```python
prettier: bool
```
- *Type:* bool
- *Default:* false
Setup prettier.
---
##### `prettier_options`Optional
```python
prettier_options: PrettierOptions
```
- *Type:* projen.javascript.PrettierOptions
- *Default:* default options
Prettier options.
---
##### `projen_dev_dependency`Optional
```python
projen_dev_dependency: bool
```
- *Type:* bool
- *Default:* true
Indicates of "projen" should be installed as a devDependency.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* true if projenrcJson is false
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options for .projenrc.js.
---
##### `projen_version`Optional
```python
projen_version: str
```
- *Type:* str
- *Default:* Defaults to the latest version.
Version of projen to install.
---
##### `pull_request_template`Optional
```python
pull_request_template: bool
```
- *Type:* bool
- *Default:* true
Include a GitHub pull request template.
---
##### `pull_request_template_contents`Optional
```python
pull_request_template_contents: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* default content
The contents of the pull request template.
---
##### `release`Optional
```python
release: bool
```
- *Type:* bool
- *Default:* true (false for subprojects)
Add release management to this project.
---
##### `release_to_npm`Optional
```python
release_to_npm: bool
```
- *Type:* bool
- *Default:* false
Automatically release to npm when new versions are introduced.
---
##### ~~`release_workflow`~~Optional
- *Deprecated:* see `release`.
```python
release_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
DEPRECATED: renamed to `release`.
---
##### `workflow_bootstrap_steps`Optional
```python
workflow_bootstrap_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* "yarn install --frozen-lockfile && yarn projen"
Workflow steps to use in order to bootstrap this repo.
---
##### `workflow_git_identity`Optional
```python
workflow_git_identity: GitIdentity
```
- *Type:* projen.github.GitIdentity
- *Default:* GitHub Actions
The git identity to use in workflows.
---
##### `workflow_node_version`Optional
```python
workflow_node_version: str
```
- *Type:* str
- *Default:* same as `minNodeVersion`
The node version to use in GitHub workflows.
---
##### `workflow_package_cache`Optional
```python
workflow_package_cache: bool
```
- *Type:* bool
- *Default:* false
Enable Node.js package cache in GitHub workflows.
---
##### `disable_tsconfig`Optional
```python
disable_tsconfig: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
---
##### `disable_tsconfig_dev`Optional
```python
disable_tsconfig_dev: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.dev.json` file.
---
##### `docgen`Optional
```python
docgen: bool
```
- *Type:* bool
- *Default:* false
Docgen by Typedoc.
---
##### `docs_directory`Optional
```python
docs_directory: str
```
- *Type:* str
- *Default:* "docs"
Docs directory.
---
##### `entrypoint_types`Optional
```python
entrypoint_types: str
```
- *Type:* str
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
The .d.ts file that includes the type declarations for this module.
---
##### `eslint`Optional
```python
eslint: bool
```
- *Type:* bool
- *Default:* true
Setup eslint.
---
##### `eslint_options`Optional
```python
eslint_options: EslintOptions
```
- *Type:* projen.javascript.EslintOptions
- *Default:* opinionated default options
Eslint options.
---
##### `libdir`Optional
```python
libdir: str
```
- *Type:* str
- *Default:* "lib"
Typescript artifacts output directory.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use TypeScript for your projenrc file (`.projenrc.ts`).
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcOptions
```
- *Type:* projen.typescript.ProjenrcOptions
Options for .projenrc.ts.
---
##### `sample_code`Optional
```python
sample_code: bool
```
- *Type:* bool
- *Default:* true
Generate one-time sample in `src/` and `test/` if there are no files there.
---
##### `srcdir`Optional
```python
srcdir: str
```
- *Type:* str
- *Default:* "src"
Typescript sources directory.
---
##### `testdir`Optional
```python
testdir: str
```
- *Type:* str
- *Default:* "test"
Jest tests directory. Tests files should be named `xxx.test.ts`.
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
then tests are going to be compiled into `lib/` and executed as javascript.
If the test directory is outside of `src`, then we configure jest to
compile the code in-memory.
---
##### `tsconfig`Optional
```python
tsconfig: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* default options
Custom TSConfig.
---
##### `tsconfig_dev`Optional
```python
tsconfig_dev: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* use the production tsconfig options
Custom tsconfig options for the development tsconfig.json file (used for testing).
---
##### `tsconfig_dev_file`Optional
```python
tsconfig_dev_file: str
```
- *Type:* str
- *Default:* "tsconfig.dev.json"
The name of the development tsconfig.json file.
---
##### `typescript_version`Optional
```python
typescript_version: str
```
- *Type:* str
- *Default:* "latest"
TypeScript version to use.
NOTE: Typescript is not semantically versioned and should remain on the
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
##### `handler_entry_points`Optional
```python
handler_entry_points: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* src/*.ts - all files directly under the src directory
Globs for lambda handler entry points, used by esbuild.
---
### GeneratedTypeScriptInfrastructureOptions
Options for configuring a generated typescript infrastructure project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedTypeScriptInfrastructureOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
allow_library_dependencies: bool = None,
author_email: str = None,
author_name: str = None,
author_organization: bool = None,
author_url: str = None,
auto_detect_bin: bool = None,
bin: typing.Mapping[str] = None,
bugs_email: str = None,
bugs_url: str = None,
bundled_deps: typing.List[str] = None,
code_artifact_options: CodeArtifactOptions = None,
deps: typing.List[str] = None,
description: str = None,
dev_deps: typing.List[str] = None,
entrypoint: str = None,
homepage: str = None,
keywords: typing.List[str] = None,
license: str = None,
licensed: bool = None,
max_node_version: str = None,
min_node_version: str = None,
npm_access: NpmAccess = None,
npm_registry: str = None,
npm_registry_url: str = None,
npm_token_secret: str = None,
package_manager: NodePackageManager = None,
package_name: str = None,
peer_dependency_options: PeerDependencyOptions = None,
peer_deps: typing.List[str] = None,
pnpm_version: str = None,
repository: str = None,
repository_directory: str = None,
scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
scripts: typing.Mapping[str] = None,
stability: str = None,
jsii_release_version: str = None,
major_version: typing.Union[int, float] = None,
min_major_version: typing.Union[int, float] = None,
npm_dist_tag: str = None,
post_build_steps: typing.List[JobStep] = None,
prerelease: str = None,
publish_dry_run: bool = None,
publish_tasks: bool = None,
release_branches: typing.Mapping[BranchOptions] = None,
release_every_commit: bool = None,
release_failure_issue: bool = None,
release_failure_issue_label: str = None,
release_schedule: str = None,
release_tag_prefix: str = None,
release_trigger: ReleaseTrigger = None,
release_workflow_name: str = None,
release_workflow_setup_steps: typing.List[JobStep] = None,
versionrc_options: typing.Mapping[typing.Any] = None,
workflow_container_image: str = None,
workflow_runs_on: typing.List[str] = None,
default_release_branch: str,
artifacts_directory: str = None,
auto_approve_upgrades: bool = None,
build_workflow: bool = None,
build_workflow_triggers: Triggers = None,
bundler_options: BundlerOptions = None,
code_cov: bool = None,
code_cov_token_secret: str = None,
copyright_owner: str = None,
copyright_period: str = None,
dependabot: bool = None,
dependabot_options: DependabotOptions = None,
deps_upgrade: bool = None,
deps_upgrade_options: UpgradeDependenciesOptions = None,
gitignore: typing.List[str] = None,
jest: bool = None,
jest_options: JestOptions = None,
mutable_build: bool = None,
npmignore: typing.List[str] = None,
npmignore_enabled: bool = None,
npm_ignore_options: IgnoreFileOptions = None,
package: bool = None,
prettier: bool = None,
prettier_options: PrettierOptions = None,
projen_dev_dependency: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projen_version: str = None,
pull_request_template: bool = None,
pull_request_template_contents: typing.List[str] = None,
release: bool = None,
release_to_npm: bool = None,
release_workflow: bool = None,
workflow_bootstrap_steps: typing.List[JobStep] = None,
workflow_git_identity: GitIdentity = None,
workflow_node_version: str = None,
workflow_package_cache: bool = None,
disable_tsconfig: bool = None,
disable_tsconfig_dev: bool = None,
docgen: bool = None,
docs_directory: str = None,
entrypoint_types: str = None,
eslint: bool = None,
eslint_options: EslintOptions = None,
libdir: str = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcOptions = None,
sample_code: bool = None,
srcdir: str = None,
testdir: str = None,
tsconfig: TypescriptConfigOptions = None,
tsconfig_dev: TypescriptConfigOptions = None,
tsconfig_dev_file: str = None,
typescript_version: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None,
mock_data_options: MockResponseDataGenerationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| author_organization | bool | Is the author an organization. |
| author_url | str | Author's URL / Website. |
| auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
| bin | typing.Mapping[str] | Binary programs vended with your module. |
| bugs_email | str | The email address to which issues should be reported. |
| bugs_url | str | The url to your project's issue tracker. |
| bundled_deps | typing.List[str] | List of dependencies to bundle into this module. |
| code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. |
| deps | typing.List[str] | Runtime dependencies of this module. |
| description | str | The description is just a string that helps people understand the purpose of the package. |
| dev_deps | typing.List[str] | Build dependencies for this module. |
| entrypoint | str | Module entrypoint (`main` in `package.json`). |
| homepage | str | Package's Homepage / Website. |
| keywords | typing.List[str] | Keywords to include in `package.json`. |
| license | str | License's SPDX identifier. |
| licensed | bool | Indicates if a license should be added. |
| max_node_version | str | Minimum node.js version to require via `engines` (inclusive). |
| min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). |
| npm_access | projen.javascript.NpmAccess | Access level of the npm package. |
| npm_registry | str | The host name of the npm registry to publish to. |
| npm_registry_url | str | The base URL of the npm package registry. |
| npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. |
| package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. |
| package_name | str | The "name" in package.json. |
| peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. |
| peer_deps | typing.List[str] | Peer dependencies for this module. |
| pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. |
| repository | str | The repository is the location where the actual code for your package lives. |
| repository_directory | str | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
| scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. |
| scripts | typing.Mapping[str] | npm scripts to include. |
| stability | str | Package's Stability. |
| jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. |
| major_version | typing.Union[int, float] | Major version to release from the default branch. |
| min_major_version | typing.Union[int, float] | Minimal Major version to release. |
| npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. |
| post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. |
| prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
| publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. |
| publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. |
| release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. |
| release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. |
| release_failure_issue | bool | Create a github issue on every failed publishing task. |
| release_failure_issue_label | str | The label to apply to issues indicating publish failures. |
| release_schedule | str | CRON schedule to trigger new releases. |
| release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
| release_trigger | projen.release.ReleaseTrigger | The release trigger to use. |
| release_workflow_name | str | The name of the default release workflow. |
| release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. |
| versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. |
| workflow_container_image | str | Container image to use for GitHub workflows. |
| workflow_runs_on | typing.List[str] | Github Runner selection labels. |
| default_release_branch | str | The name of the main release branch. |
| artifacts_directory | str | A directory which will contain build artifacts. |
| auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
| build_workflow | bool | Define a GitHub workflow for building PRs. |
| build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. |
| bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. |
| code_cov | bool | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
| code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
| copyright_owner | str | License copyright owner. |
| copyright_period | str | The copyright years to put in the LICENSE file. |
| dependabot | bool | Use dependabot to handle dependency upgrades. |
| dependabot_options | projen.github.DependabotOptions | Options for dependabot. |
| deps_upgrade | bool | Use github workflows to handle dependency upgrades. |
| deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. |
| gitignore | typing.List[str] | Additional entries to .gitignore. |
| jest | bool | Setup jest unit tests. |
| jest_options | projen.javascript.JestOptions | Jest options. |
| mutable_build | bool | Automatically update files modified during builds to pull-request branches. |
| npmignore | typing.List[str] | Additional entries to .npmignore. |
| npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
| npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. |
| package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
| prettier | bool | Setup prettier. |
| prettier_options | projen.javascript.PrettierOptions | Prettier options. |
| projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. |
| projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. |
| projen_version | str | Version of projen to install. |
| pull_request_template | bool | Include a GitHub pull request template. |
| pull_request_template_contents | typing.List[str] | The contents of the pull request template. |
| release | bool | Add release management to this project. |
| release_to_npm | bool | Automatically release to npm when new versions are introduced. |
| release_workflow | bool | DEPRECATED: renamed to `release`. |
| workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. |
| workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. |
| workflow_node_version | str | The node version to use in GitHub workflows. |
| workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. |
| disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
| disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. |
| docgen | bool | Docgen by Typedoc. |
| docs_directory | str | Docs directory. |
| entrypoint_types | str | The .d.ts file that includes the type declarations for this module. |
| eslint | bool | Setup eslint. |
| eslint_options | projen.javascript.EslintOptions | Eslint options. |
| libdir | str | Typescript artifacts output directory. |
| projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). |
| projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. |
| sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. |
| srcdir | str | Typescript sources directory. |
| testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. |
| tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. |
| tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). |
| tsconfig_dev_file | str | The name of the development tsconfig.json file. |
| typescript_version | str | TypeScript version to use. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
| mock_data_options | MockResponseDataGenerationOptions | Options for the generated mock response data. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `allow_library_dependencies`Optional
```python
allow_library_dependencies: bool
```
- *Type:* bool
- *Default:* true
Allow the project to include `peerDependencies` and `bundledDependencies`.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
---
##### `author_email`Optional
```python
author_email: str
```
- *Type:* str
Author's e-mail.
---
##### `author_name`Optional
```python
author_name: str
```
- *Type:* str
Author's name.
---
##### `author_organization`Optional
```python
author_organization: bool
```
- *Type:* bool
Is the author an organization.
---
##### `author_url`Optional
```python
author_url: str
```
- *Type:* str
Author's URL / Website.
---
##### `auto_detect_bin`Optional
```python
auto_detect_bin: bool
```
- *Type:* bool
- *Default:* true
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
---
##### `bin`Optional
```python
bin: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Binary programs vended with your module.
You can use this option to add/customize how binaries are represented in
your `package.json`, but unless `autoDetectBin` is `false`, every
executable file under `bin` will automatically be added to this section.
---
##### `bugs_email`Optional
```python
bugs_email: str
```
- *Type:* str
The email address to which issues should be reported.
---
##### `bugs_url`Optional
```python
bugs_url: str
```
- *Type:* str
The url to your project's issue tracker.
---
##### `bundled_deps`Optional
```python
bundled_deps: typing.List[str]
```
- *Type:* typing.List[str]
List of dependencies to bundle into this module.
These modules will be
added both to the `dependencies` section and `bundledDependencies` section of
your `package.json`.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
##### `code_artifact_options`Optional
```python
code_artifact_options: CodeArtifactOptions
```
- *Type:* projen.javascript.CodeArtifactOptions
- *Default:* undefined
Options for npm packages using AWS CodeArtifact.
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Runtime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'express', 'lodash', 'foo@^2' ]
```
##### `description`Optional
```python
description: str
```
- *Type:* str
The description is just a string that helps people understand the purpose of the package.
It can be used when searching for packages in a package manager as well.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Build dependencies for this module.
These dependencies will only be
available in your build environment but will not be fetched when this
module is consumed.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'typescript', '@types/express' ]
```
##### `entrypoint`Optional
```python
entrypoint: str
```
- *Type:* str
- *Default:* "lib/index.js"
Module entrypoint (`main` in `package.json`).
Set to an empty string to not include `main` in your package.json
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
Package's Homepage / Website.
---
##### `keywords`Optional
```python
keywords: typing.List[str]
```
- *Type:* typing.List[str]
Keywords to include in `package.json`.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
- *Default:* "Apache-2.0"
License's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the `licensed` option if you want to no license to be specified.
---
##### `licensed`Optional
```python
licensed: bool
```
- *Type:* bool
- *Default:* true
Indicates if a license should be added.
---
##### `max_node_version`Optional
```python
max_node_version: str
```
- *Type:* str
- *Default:* no max
Minimum node.js version to require via `engines` (inclusive).
---
##### `min_node_version`Optional
```python
min_node_version: str
```
- *Type:* str
- *Default:* no "engines" specified
Minimum Node.js version to require via package.json `engines` (inclusive).
---
##### `npm_access`Optional
```python
npm_access: NpmAccess
```
- *Type:* projen.javascript.NpmAccess
- *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
Access level of the npm package.
---
##### ~~`npm_registry`~~Optional
- *Deprecated:* use `npmRegistryUrl` instead
```python
npm_registry: str
```
- *Type:* str
The host name of the npm registry to publish to.
Cannot be set together with `npmRegistryUrl`.
---
##### `npm_registry_url`Optional
```python
npm_registry_url: str
```
- *Type:* str
- *Default:* "https://registry.npmjs.org"
The base URL of the npm package registry.
Must be a URL (e.g. start with "https://" or "http://")
---
##### `npm_token_secret`Optional
```python
npm_token_secret: str
```
- *Type:* str
- *Default:* "NPM_TOKEN"
GitHub secret which contains the NPM token to use when publishing packages.
---
##### `package_manager`Optional
```python
package_manager: NodePackageManager
```
- *Type:* projen.javascript.NodePackageManager
- *Default:* NodePackageManager.YARN
The Node Package Manager used to execute scripts.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
- *Default:* defaults to project name
The "name" in package.json.
---
##### `peer_dependency_options`Optional
```python
peer_dependency_options: PeerDependencyOptions
```
- *Type:* projen.javascript.PeerDependencyOptions
Options for `peerDeps`.
---
##### `peer_deps`Optional
```python
peer_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Peer dependencies for this module.
Dependencies listed here are required to
be installed (and satisfied) by the _consumer_ of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the `node_modules` tree of your consumers.
Note that prior to npm@7, peer dependencies are _not_ automatically
installed, which means that adding peer dependencies to a library will be a
breaking change for your customers.
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
---
##### `pnpm_version`Optional
```python
pnpm_version: str
```
- *Type:* str
- *Default:* "7"
The version of PNPM to use if using PNPM as a package manager.
---
##### `repository`Optional
```python
repository: str
```
- *Type:* str
The repository is the location where the actual code for your package lives.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
---
##### `repository_directory`Optional
```python
repository_directory: str
```
- *Type:* str
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
---
##### `scoped_packages_options`Optional
```python
scoped_packages_options: typing.List[ScopedPackagesOptions]
```
- *Type:* typing.List[projen.javascript.ScopedPackagesOptions]
- *Default:* fetch all scoped packages from the public npm registry
Options for privately hosted scoped packages.
---
##### ~~`scripts`~~Optional
- *Deprecated:* use `project.addTask()` or `package.setScript()`
```python
scripts: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
- *Default:* {}
npm scripts to include.
If a script has the same name as a standard script,
the standard script will be overwritten.
Also adds the script as a task.
---
##### `stability`Optional
```python
stability: str
```
- *Type:* str
Package's Stability.
---
##### `jsii_release_version`Optional
```python
jsii_release_version: str
```
- *Type:* str
- *Default:* "latest"
Version requirement of `publib` which is used to publish modules to npm.
---
##### `major_version`Optional
```python
major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* Major version is not enforced.
Major version to release from the default branch.
If this is specified, we bump the latest version of this major version line.
If not specified, we bump the global latest version.
---
##### `min_major_version`Optional
```python
min_major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* No minimum version is being enforced
Minimal Major version to release.
This can be useful to set to 1, as breaking changes before the 1.x major
release are not incrementing the major version number.
Can not be set together with `majorVersion`.
---
##### `npm_dist_tag`Optional
```python
npm_dist_tag: str
```
- *Type:* str
- *Default:* "latest"
The npmDistTag to use when publishing from the default branch.
To set the npm dist-tag for release branches, set the `npmDistTag` property
for each branch.
---
##### `post_build_steps`Optional
```python
post_build_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* []
Steps to execute after build as part of the release workflow.
---
##### `prerelease`Optional
```python
prerelease: str
```
- *Type:* str
- *Default:* normal semantic versions
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
---
##### `publish_dry_run`Optional
```python
publish_dry_run: bool
```
- *Type:* bool
- *Default:* false
Instead of actually publishing to package managers, just print the publishing command.
---
##### `publish_tasks`Optional
```python
publish_tasks: bool
```
- *Type:* bool
- *Default:* false
Define publishing tasks that can be executed manually as well as workflows.
Normally, publishing only happens within automated workflows. Enable this
in order to create a publishing task for each publishing activity.
---
##### `release_branches`Optional
```python
release_branches: typing.Mapping[BranchOptions]
```
- *Type:* typing.Mapping[projen.release.BranchOptions]
- *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
Defines additional release branches.
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch _must_ be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the `majorVersion` field must also
be provided for the default branch.
---
##### ~~`release_every_commit`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
```python
release_every_commit: bool
```
- *Type:* bool
- *Default:* true
Automatically release new versions every commit to one of branches in `releaseBranches`.
---
##### `release_failure_issue`Optional
```python
release_failure_issue: bool
```
- *Type:* bool
- *Default:* false
Create a github issue on every failed publishing task.
---
##### `release_failure_issue_label`Optional
```python
release_failure_issue_label: str
```
- *Type:* str
- *Default:* "failed-release"
The label to apply to issues indicating publish failures.
Only applies if `releaseFailureIssue` is true.
---
##### ~~`release_schedule`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
```python
release_schedule: str
```
- *Type:* str
- *Default:* no scheduled releases
CRON schedule to trigger new releases.
---
##### `release_tag_prefix`Optional
```python
release_tag_prefix: str
```
- *Type:* str
- *Default:* "v"
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
Note: this prefix is used to detect the latest tagged version
when bumping, so if you change this on a project with an existing version
history, you may need to manually tag your latest release
with the new prefix.
---
##### `release_trigger`Optional
```python
release_trigger: ReleaseTrigger
```
- *Type:* projen.release.ReleaseTrigger
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
The release trigger to use.
---
##### `release_workflow_name`Optional
```python
release_workflow_name: str
```
- *Type:* str
- *Default:* "Release"
The name of the default release workflow.
---
##### `release_workflow_setup_steps`Optional
```python
release_workflow_setup_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
A set of workflow steps to execute in order to setup the workflow container.
---
##### `versionrc_options`Optional
```python
versionrc_options: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
- *Default:* standard configuration applicable for GitHub repositories
Custom configuration used when creating changelog with standard-version package.
Given values either append to default configuration or overwrite values in it.
---
##### `workflow_container_image`Optional
```python
workflow_container_image: str
```
- *Type:* str
- *Default:* default image
Container image to use for GitHub workflows.
---
##### `workflow_runs_on`Optional
```python
workflow_runs_on: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* ["ubuntu-latest"]
Github Runner selection labels.
---
##### `default_release_branch`Required
```python
default_release_branch: str
```
- *Type:* str
- *Default:* "main"
The name of the main release branch.
---
##### `artifacts_directory`Optional
```python
artifacts_directory: str
```
- *Type:* str
- *Default:* "dist"
A directory which will contain build artifacts.
---
##### `auto_approve_upgrades`Optional
```python
auto_approve_upgrades: bool
```
- *Type:* bool
- *Default:* true
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but `autoApproveOptions` are not defined.
---
##### `build_workflow`Optional
```python
build_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
Define a GitHub workflow for building PRs.
---
##### `build_workflow_triggers`Optional
```python
build_workflow_triggers: Triggers
```
- *Type:* projen.github.workflows.Triggers
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
Build workflow triggers.
---
##### `bundler_options`Optional
```python
bundler_options: BundlerOptions
```
- *Type:* projen.javascript.BundlerOptions
Options for `Bundler`.
---
##### `code_cov`Optional
```python
code_cov: bool
```
- *Type:* bool
- *Default:* false
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
---
##### `code_cov_token_secret`Optional
```python
code_cov_token_secret: str
```
- *Type:* str
- *Default:* if this option is not specified, only public repositories are supported
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
---
##### `copyright_owner`Optional
```python
copyright_owner: str
```
- *Type:* str
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
License copyright owner.
---
##### `copyright_period`Optional
```python
copyright_period: str
```
- *Type:* str
- *Default:* current year
The copyright years to put in the LICENSE file.
---
##### `dependabot`Optional
```python
dependabot: bool
```
- *Type:* bool
- *Default:* false
Use dependabot to handle dependency upgrades.
Cannot be used in conjunction with `depsUpgrade`.
---
##### `dependabot_options`Optional
```python
dependabot_options: DependabotOptions
```
- *Type:* projen.github.DependabotOptions
- *Default:* default options
Options for dependabot.
---
##### `deps_upgrade`Optional
```python
deps_upgrade: bool
```
- *Type:* bool
- *Default:* true
Use github workflows to handle dependency upgrades.
Cannot be used in conjunction with `dependabot`.
---
##### `deps_upgrade_options`Optional
```python
deps_upgrade_options: UpgradeDependenciesOptions
```
- *Type:* projen.javascript.UpgradeDependenciesOptions
- *Default:* default options
Options for `UpgradeDependencies`.
---
##### `gitignore`Optional
```python
gitignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .gitignore.
---
##### `jest`Optional
```python
jest: bool
```
- *Type:* bool
- *Default:* true
Setup jest unit tests.
---
##### `jest_options`Optional
```python
jest_options: JestOptions
```
- *Type:* projen.javascript.JestOptions
- *Default:* default options
Jest options.
---
##### `mutable_build`Optional
```python
mutable_build: bool
```
- *Type:* bool
- *Default:* true
Automatically update files modified during builds to pull-request branches.
This means
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
---
##### ~~`npmignore`~~Optional
- *Deprecated:* - use `project.addPackageIgnore`
```python
npmignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .npmignore.
---
##### `npmignore_enabled`Optional
```python
npmignore_enabled: bool
```
- *Type:* bool
- *Default:* true
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
---
##### `npm_ignore_options`Optional
```python
npm_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .npmignore file.
---
##### `package`Optional
```python
package: bool
```
- *Type:* bool
- *Default:* true
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
---
##### `prettier`Optional
```python
prettier: bool
```
- *Type:* bool
- *Default:* false
Setup prettier.
---
##### `prettier_options`Optional
```python
prettier_options: PrettierOptions
```
- *Type:* projen.javascript.PrettierOptions
- *Default:* default options
Prettier options.
---
##### `projen_dev_dependency`Optional
```python
projen_dev_dependency: bool
```
- *Type:* bool
- *Default:* true
Indicates of "projen" should be installed as a devDependency.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* true if projenrcJson is false
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options for .projenrc.js.
---
##### `projen_version`Optional
```python
projen_version: str
```
- *Type:* str
- *Default:* Defaults to the latest version.
Version of projen to install.
---
##### `pull_request_template`Optional
```python
pull_request_template: bool
```
- *Type:* bool
- *Default:* true
Include a GitHub pull request template.
---
##### `pull_request_template_contents`Optional
```python
pull_request_template_contents: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* default content
The contents of the pull request template.
---
##### `release`Optional
```python
release: bool
```
- *Type:* bool
- *Default:* true (false for subprojects)
Add release management to this project.
---
##### `release_to_npm`Optional
```python
release_to_npm: bool
```
- *Type:* bool
- *Default:* false
Automatically release to npm when new versions are introduced.
---
##### ~~`release_workflow`~~Optional
- *Deprecated:* see `release`.
```python
release_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
DEPRECATED: renamed to `release`.
---
##### `workflow_bootstrap_steps`Optional
```python
workflow_bootstrap_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* "yarn install --frozen-lockfile && yarn projen"
Workflow steps to use in order to bootstrap this repo.
---
##### `workflow_git_identity`Optional
```python
workflow_git_identity: GitIdentity
```
- *Type:* projen.github.GitIdentity
- *Default:* GitHub Actions
The git identity to use in workflows.
---
##### `workflow_node_version`Optional
```python
workflow_node_version: str
```
- *Type:* str
- *Default:* same as `minNodeVersion`
The node version to use in GitHub workflows.
---
##### `workflow_package_cache`Optional
```python
workflow_package_cache: bool
```
- *Type:* bool
- *Default:* false
Enable Node.js package cache in GitHub workflows.
---
##### `disable_tsconfig`Optional
```python
disable_tsconfig: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
---
##### `disable_tsconfig_dev`Optional
```python
disable_tsconfig_dev: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.dev.json` file.
---
##### `docgen`Optional
```python
docgen: bool
```
- *Type:* bool
- *Default:* false
Docgen by Typedoc.
---
##### `docs_directory`Optional
```python
docs_directory: str
```
- *Type:* str
- *Default:* "docs"
Docs directory.
---
##### `entrypoint_types`Optional
```python
entrypoint_types: str
```
- *Type:* str
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
The .d.ts file that includes the type declarations for this module.
---
##### `eslint`Optional
```python
eslint: bool
```
- *Type:* bool
- *Default:* true
Setup eslint.
---
##### `eslint_options`Optional
```python
eslint_options: EslintOptions
```
- *Type:* projen.javascript.EslintOptions
- *Default:* opinionated default options
Eslint options.
---
##### `libdir`Optional
```python
libdir: str
```
- *Type:* str
- *Default:* "lib"
Typescript artifacts output directory.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use TypeScript for your projenrc file (`.projenrc.ts`).
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcOptions
```
- *Type:* projen.typescript.ProjenrcOptions
Options for .projenrc.ts.
---
##### `sample_code`Optional
```python
sample_code: bool
```
- *Type:* bool
- *Default:* true
Generate one-time sample in `src/` and `test/` if there are no files there.
---
##### `srcdir`Optional
```python
srcdir: str
```
- *Type:* str
- *Default:* "src"
Typescript sources directory.
---
##### `testdir`Optional
```python
testdir: str
```
- *Type:* str
- *Default:* "test"
Jest tests directory. Tests files should be named `xxx.test.ts`.
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
then tests are going to be compiled into `lib/` and executed as javascript.
If the test directory is outside of `src`, then we configure jest to
compile the code in-memory.
---
##### `tsconfig`Optional
```python
tsconfig: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* default options
Custom TSConfig.
---
##### `tsconfig_dev`Optional
```python
tsconfig_dev: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* use the production tsconfig options
Custom tsconfig options for the development tsconfig.json file (used for testing).
---
##### `tsconfig_dev_file`Optional
```python
tsconfig_dev_file: str
```
- *Type:* str
- *Default:* "tsconfig.dev.json"
The name of the development tsconfig.json file.
---
##### `typescript_version`Optional
```python
typescript_version: str
```
- *Type:* str
- *Default:* "latest"
TypeScript version to use.
NOTE: Typescript is not semantically versioned and should remain on the
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
##### `mock_data_options`Optional
```python
mock_data_options: MockResponseDataGenerationOptions
```
- *Type:* MockResponseDataGenerationOptions
Options for the generated mock response data.
---
### GeneratedTypeScriptReactQueryHooksOptions
Options for configuring a generated typescript hooks library project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedTypeScriptReactQueryHooksOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
allow_library_dependencies: bool = None,
author_email: str = None,
author_name: str = None,
author_organization: bool = None,
author_url: str = None,
auto_detect_bin: bool = None,
bin: typing.Mapping[str] = None,
bugs_email: str = None,
bugs_url: str = None,
bundled_deps: typing.List[str] = None,
code_artifact_options: CodeArtifactOptions = None,
deps: typing.List[str] = None,
description: str = None,
dev_deps: typing.List[str] = None,
entrypoint: str = None,
homepage: str = None,
keywords: typing.List[str] = None,
license: str = None,
licensed: bool = None,
max_node_version: str = None,
min_node_version: str = None,
npm_access: NpmAccess = None,
npm_registry: str = None,
npm_registry_url: str = None,
npm_token_secret: str = None,
package_manager: NodePackageManager = None,
package_name: str = None,
peer_dependency_options: PeerDependencyOptions = None,
peer_deps: typing.List[str] = None,
pnpm_version: str = None,
repository: str = None,
repository_directory: str = None,
scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
scripts: typing.Mapping[str] = None,
stability: str = None,
jsii_release_version: str = None,
major_version: typing.Union[int, float] = None,
min_major_version: typing.Union[int, float] = None,
npm_dist_tag: str = None,
post_build_steps: typing.List[JobStep] = None,
prerelease: str = None,
publish_dry_run: bool = None,
publish_tasks: bool = None,
release_branches: typing.Mapping[BranchOptions] = None,
release_every_commit: bool = None,
release_failure_issue: bool = None,
release_failure_issue_label: str = None,
release_schedule: str = None,
release_tag_prefix: str = None,
release_trigger: ReleaseTrigger = None,
release_workflow_name: str = None,
release_workflow_setup_steps: typing.List[JobStep] = None,
versionrc_options: typing.Mapping[typing.Any] = None,
workflow_container_image: str = None,
workflow_runs_on: typing.List[str] = None,
default_release_branch: str,
artifacts_directory: str = None,
auto_approve_upgrades: bool = None,
build_workflow: bool = None,
build_workflow_triggers: Triggers = None,
bundler_options: BundlerOptions = None,
code_cov: bool = None,
code_cov_token_secret: str = None,
copyright_owner: str = None,
copyright_period: str = None,
dependabot: bool = None,
dependabot_options: DependabotOptions = None,
deps_upgrade: bool = None,
deps_upgrade_options: UpgradeDependenciesOptions = None,
gitignore: typing.List[str] = None,
jest: bool = None,
jest_options: JestOptions = None,
mutable_build: bool = None,
npmignore: typing.List[str] = None,
npmignore_enabled: bool = None,
npm_ignore_options: IgnoreFileOptions = None,
package: bool = None,
prettier: bool = None,
prettier_options: PrettierOptions = None,
projen_dev_dependency: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projen_version: str = None,
pull_request_template: bool = None,
pull_request_template_contents: typing.List[str] = None,
release: bool = None,
release_to_npm: bool = None,
release_workflow: bool = None,
workflow_bootstrap_steps: typing.List[JobStep] = None,
workflow_git_identity: GitIdentity = None,
workflow_node_version: str = None,
workflow_package_cache: bool = None,
disable_tsconfig: bool = None,
disable_tsconfig_dev: bool = None,
docgen: bool = None,
docs_directory: str = None,
entrypoint_types: str = None,
eslint: bool = None,
eslint_options: EslintOptions = None,
libdir: str = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcOptions = None,
sample_code: bool = None,
srcdir: str = None,
testdir: str = None,
tsconfig: TypescriptConfigOptions = None,
tsconfig_dev: TypescriptConfigOptions = None,
tsconfig_dev_file: str = None,
typescript_version: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| author_organization | bool | Is the author an organization. |
| author_url | str | Author's URL / Website. |
| auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
| bin | typing.Mapping[str] | Binary programs vended with your module. |
| bugs_email | str | The email address to which issues should be reported. |
| bugs_url | str | The url to your project's issue tracker. |
| bundled_deps | typing.List[str] | List of dependencies to bundle into this module. |
| code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. |
| deps | typing.List[str] | Runtime dependencies of this module. |
| description | str | The description is just a string that helps people understand the purpose of the package. |
| dev_deps | typing.List[str] | Build dependencies for this module. |
| entrypoint | str | Module entrypoint (`main` in `package.json`). |
| homepage | str | Package's Homepage / Website. |
| keywords | typing.List[str] | Keywords to include in `package.json`. |
| license | str | License's SPDX identifier. |
| licensed | bool | Indicates if a license should be added. |
| max_node_version | str | Minimum node.js version to require via `engines` (inclusive). |
| min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). |
| npm_access | projen.javascript.NpmAccess | Access level of the npm package. |
| npm_registry | str | The host name of the npm registry to publish to. |
| npm_registry_url | str | The base URL of the npm package registry. |
| npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. |
| package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. |
| package_name | str | The "name" in package.json. |
| peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. |
| peer_deps | typing.List[str] | Peer dependencies for this module. |
| pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. |
| repository | str | The repository is the location where the actual code for your package lives. |
| repository_directory | str | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
| scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. |
| scripts | typing.Mapping[str] | npm scripts to include. |
| stability | str | Package's Stability. |
| jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. |
| major_version | typing.Union[int, float] | Major version to release from the default branch. |
| min_major_version | typing.Union[int, float] | Minimal Major version to release. |
| npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. |
| post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. |
| prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
| publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. |
| publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. |
| release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. |
| release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. |
| release_failure_issue | bool | Create a github issue on every failed publishing task. |
| release_failure_issue_label | str | The label to apply to issues indicating publish failures. |
| release_schedule | str | CRON schedule to trigger new releases. |
| release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
| release_trigger | projen.release.ReleaseTrigger | The release trigger to use. |
| release_workflow_name | str | The name of the default release workflow. |
| release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. |
| versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. |
| workflow_container_image | str | Container image to use for GitHub workflows. |
| workflow_runs_on | typing.List[str] | Github Runner selection labels. |
| default_release_branch | str | The name of the main release branch. |
| artifacts_directory | str | A directory which will contain build artifacts. |
| auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
| build_workflow | bool | Define a GitHub workflow for building PRs. |
| build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. |
| bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. |
| code_cov | bool | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
| code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
| copyright_owner | str | License copyright owner. |
| copyright_period | str | The copyright years to put in the LICENSE file. |
| dependabot | bool | Use dependabot to handle dependency upgrades. |
| dependabot_options | projen.github.DependabotOptions | Options for dependabot. |
| deps_upgrade | bool | Use github workflows to handle dependency upgrades. |
| deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. |
| gitignore | typing.List[str] | Additional entries to .gitignore. |
| jest | bool | Setup jest unit tests. |
| jest_options | projen.javascript.JestOptions | Jest options. |
| mutable_build | bool | Automatically update files modified during builds to pull-request branches. |
| npmignore | typing.List[str] | Additional entries to .npmignore. |
| npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
| npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. |
| package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
| prettier | bool | Setup prettier. |
| prettier_options | projen.javascript.PrettierOptions | Prettier options. |
| projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. |
| projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. |
| projen_version | str | Version of projen to install. |
| pull_request_template | bool | Include a GitHub pull request template. |
| pull_request_template_contents | typing.List[str] | The contents of the pull request template. |
| release | bool | Add release management to this project. |
| release_to_npm | bool | Automatically release to npm when new versions are introduced. |
| release_workflow | bool | DEPRECATED: renamed to `release`. |
| workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. |
| workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. |
| workflow_node_version | str | The node version to use in GitHub workflows. |
| workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. |
| disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
| disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. |
| docgen | bool | Docgen by Typedoc. |
| docs_directory | str | Docs directory. |
| entrypoint_types | str | The .d.ts file that includes the type declarations for this module. |
| eslint | bool | Setup eslint. |
| eslint_options | projen.javascript.EslintOptions | Eslint options. |
| libdir | str | Typescript artifacts output directory. |
| projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). |
| projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. |
| sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. |
| srcdir | str | Typescript sources directory. |
| testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. |
| tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. |
| tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). |
| tsconfig_dev_file | str | The name of the development tsconfig.json file. |
| typescript_version | str | TypeScript version to use. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `allow_library_dependencies`Optional
```python
allow_library_dependencies: bool
```
- *Type:* bool
- *Default:* true
Allow the project to include `peerDependencies` and `bundledDependencies`.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
---
##### `author_email`Optional
```python
author_email: str
```
- *Type:* str
Author's e-mail.
---
##### `author_name`Optional
```python
author_name: str
```
- *Type:* str
Author's name.
---
##### `author_organization`Optional
```python
author_organization: bool
```
- *Type:* bool
Is the author an organization.
---
##### `author_url`Optional
```python
author_url: str
```
- *Type:* str
Author's URL / Website.
---
##### `auto_detect_bin`Optional
```python
auto_detect_bin: bool
```
- *Type:* bool
- *Default:* true
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
---
##### `bin`Optional
```python
bin: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Binary programs vended with your module.
You can use this option to add/customize how binaries are represented in
your `package.json`, but unless `autoDetectBin` is `false`, every
executable file under `bin` will automatically be added to this section.
---
##### `bugs_email`Optional
```python
bugs_email: str
```
- *Type:* str
The email address to which issues should be reported.
---
##### `bugs_url`Optional
```python
bugs_url: str
```
- *Type:* str
The url to your project's issue tracker.
---
##### `bundled_deps`Optional
```python
bundled_deps: typing.List[str]
```
- *Type:* typing.List[str]
List of dependencies to bundle into this module.
These modules will be
added both to the `dependencies` section and `bundledDependencies` section of
your `package.json`.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
##### `code_artifact_options`Optional
```python
code_artifact_options: CodeArtifactOptions
```
- *Type:* projen.javascript.CodeArtifactOptions
- *Default:* undefined
Options for npm packages using AWS CodeArtifact.
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Runtime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'express', 'lodash', 'foo@^2' ]
```
##### `description`Optional
```python
description: str
```
- *Type:* str
The description is just a string that helps people understand the purpose of the package.
It can be used when searching for packages in a package manager as well.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Build dependencies for this module.
These dependencies will only be
available in your build environment but will not be fetched when this
module is consumed.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'typescript', '@types/express' ]
```
##### `entrypoint`Optional
```python
entrypoint: str
```
- *Type:* str
- *Default:* "lib/index.js"
Module entrypoint (`main` in `package.json`).
Set to an empty string to not include `main` in your package.json
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
Package's Homepage / Website.
---
##### `keywords`Optional
```python
keywords: typing.List[str]
```
- *Type:* typing.List[str]
Keywords to include in `package.json`.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
- *Default:* "Apache-2.0"
License's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the `licensed` option if you want to no license to be specified.
---
##### `licensed`Optional
```python
licensed: bool
```
- *Type:* bool
- *Default:* true
Indicates if a license should be added.
---
##### `max_node_version`Optional
```python
max_node_version: str
```
- *Type:* str
- *Default:* no max
Minimum node.js version to require via `engines` (inclusive).
---
##### `min_node_version`Optional
```python
min_node_version: str
```
- *Type:* str
- *Default:* no "engines" specified
Minimum Node.js version to require via package.json `engines` (inclusive).
---
##### `npm_access`Optional
```python
npm_access: NpmAccess
```
- *Type:* projen.javascript.NpmAccess
- *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
Access level of the npm package.
---
##### ~~`npm_registry`~~Optional
- *Deprecated:* use `npmRegistryUrl` instead
```python
npm_registry: str
```
- *Type:* str
The host name of the npm registry to publish to.
Cannot be set together with `npmRegistryUrl`.
---
##### `npm_registry_url`Optional
```python
npm_registry_url: str
```
- *Type:* str
- *Default:* "https://registry.npmjs.org"
The base URL of the npm package registry.
Must be a URL (e.g. start with "https://" or "http://")
---
##### `npm_token_secret`Optional
```python
npm_token_secret: str
```
- *Type:* str
- *Default:* "NPM_TOKEN"
GitHub secret which contains the NPM token to use when publishing packages.
---
##### `package_manager`Optional
```python
package_manager: NodePackageManager
```
- *Type:* projen.javascript.NodePackageManager
- *Default:* NodePackageManager.YARN
The Node Package Manager used to execute scripts.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
- *Default:* defaults to project name
The "name" in package.json.
---
##### `peer_dependency_options`Optional
```python
peer_dependency_options: PeerDependencyOptions
```
- *Type:* projen.javascript.PeerDependencyOptions
Options for `peerDeps`.
---
##### `peer_deps`Optional
```python
peer_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Peer dependencies for this module.
Dependencies listed here are required to
be installed (and satisfied) by the _consumer_ of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the `node_modules` tree of your consumers.
Note that prior to npm@7, peer dependencies are _not_ automatically
installed, which means that adding peer dependencies to a library will be a
breaking change for your customers.
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
---
##### `pnpm_version`Optional
```python
pnpm_version: str
```
- *Type:* str
- *Default:* "7"
The version of PNPM to use if using PNPM as a package manager.
---
##### `repository`Optional
```python
repository: str
```
- *Type:* str
The repository is the location where the actual code for your package lives.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
---
##### `repository_directory`Optional
```python
repository_directory: str
```
- *Type:* str
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
---
##### `scoped_packages_options`Optional
```python
scoped_packages_options: typing.List[ScopedPackagesOptions]
```
- *Type:* typing.List[projen.javascript.ScopedPackagesOptions]
- *Default:* fetch all scoped packages from the public npm registry
Options for privately hosted scoped packages.
---
##### ~~`scripts`~~Optional
- *Deprecated:* use `project.addTask()` or `package.setScript()`
```python
scripts: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
- *Default:* {}
npm scripts to include.
If a script has the same name as a standard script,
the standard script will be overwritten.
Also adds the script as a task.
---
##### `stability`Optional
```python
stability: str
```
- *Type:* str
Package's Stability.
---
##### `jsii_release_version`Optional
```python
jsii_release_version: str
```
- *Type:* str
- *Default:* "latest"
Version requirement of `publib` which is used to publish modules to npm.
---
##### `major_version`Optional
```python
major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* Major version is not enforced.
Major version to release from the default branch.
If this is specified, we bump the latest version of this major version line.
If not specified, we bump the global latest version.
---
##### `min_major_version`Optional
```python
min_major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* No minimum version is being enforced
Minimal Major version to release.
This can be useful to set to 1, as breaking changes before the 1.x major
release are not incrementing the major version number.
Can not be set together with `majorVersion`.
---
##### `npm_dist_tag`Optional
```python
npm_dist_tag: str
```
- *Type:* str
- *Default:* "latest"
The npmDistTag to use when publishing from the default branch.
To set the npm dist-tag for release branches, set the `npmDistTag` property
for each branch.
---
##### `post_build_steps`Optional
```python
post_build_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* []
Steps to execute after build as part of the release workflow.
---
##### `prerelease`Optional
```python
prerelease: str
```
- *Type:* str
- *Default:* normal semantic versions
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
---
##### `publish_dry_run`Optional
```python
publish_dry_run: bool
```
- *Type:* bool
- *Default:* false
Instead of actually publishing to package managers, just print the publishing command.
---
##### `publish_tasks`Optional
```python
publish_tasks: bool
```
- *Type:* bool
- *Default:* false
Define publishing tasks that can be executed manually as well as workflows.
Normally, publishing only happens within automated workflows. Enable this
in order to create a publishing task for each publishing activity.
---
##### `release_branches`Optional
```python
release_branches: typing.Mapping[BranchOptions]
```
- *Type:* typing.Mapping[projen.release.BranchOptions]
- *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
Defines additional release branches.
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch _must_ be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the `majorVersion` field must also
be provided for the default branch.
---
##### ~~`release_every_commit`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
```python
release_every_commit: bool
```
- *Type:* bool
- *Default:* true
Automatically release new versions every commit to one of branches in `releaseBranches`.
---
##### `release_failure_issue`Optional
```python
release_failure_issue: bool
```
- *Type:* bool
- *Default:* false
Create a github issue on every failed publishing task.
---
##### `release_failure_issue_label`Optional
```python
release_failure_issue_label: str
```
- *Type:* str
- *Default:* "failed-release"
The label to apply to issues indicating publish failures.
Only applies if `releaseFailureIssue` is true.
---
##### ~~`release_schedule`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
```python
release_schedule: str
```
- *Type:* str
- *Default:* no scheduled releases
CRON schedule to trigger new releases.
---
##### `release_tag_prefix`Optional
```python
release_tag_prefix: str
```
- *Type:* str
- *Default:* "v"
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
Note: this prefix is used to detect the latest tagged version
when bumping, so if you change this on a project with an existing version
history, you may need to manually tag your latest release
with the new prefix.
---
##### `release_trigger`Optional
```python
release_trigger: ReleaseTrigger
```
- *Type:* projen.release.ReleaseTrigger
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
The release trigger to use.
---
##### `release_workflow_name`Optional
```python
release_workflow_name: str
```
- *Type:* str
- *Default:* "Release"
The name of the default release workflow.
---
##### `release_workflow_setup_steps`Optional
```python
release_workflow_setup_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
A set of workflow steps to execute in order to setup the workflow container.
---
##### `versionrc_options`Optional
```python
versionrc_options: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
- *Default:* standard configuration applicable for GitHub repositories
Custom configuration used when creating changelog with standard-version package.
Given values either append to default configuration or overwrite values in it.
---
##### `workflow_container_image`Optional
```python
workflow_container_image: str
```
- *Type:* str
- *Default:* default image
Container image to use for GitHub workflows.
---
##### `workflow_runs_on`Optional
```python
workflow_runs_on: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* ["ubuntu-latest"]
Github Runner selection labels.
---
##### `default_release_branch`Required
```python
default_release_branch: str
```
- *Type:* str
- *Default:* "main"
The name of the main release branch.
---
##### `artifacts_directory`Optional
```python
artifacts_directory: str
```
- *Type:* str
- *Default:* "dist"
A directory which will contain build artifacts.
---
##### `auto_approve_upgrades`Optional
```python
auto_approve_upgrades: bool
```
- *Type:* bool
- *Default:* true
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but `autoApproveOptions` are not defined.
---
##### `build_workflow`Optional
```python
build_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
Define a GitHub workflow for building PRs.
---
##### `build_workflow_triggers`Optional
```python
build_workflow_triggers: Triggers
```
- *Type:* projen.github.workflows.Triggers
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
Build workflow triggers.
---
##### `bundler_options`Optional
```python
bundler_options: BundlerOptions
```
- *Type:* projen.javascript.BundlerOptions
Options for `Bundler`.
---
##### `code_cov`Optional
```python
code_cov: bool
```
- *Type:* bool
- *Default:* false
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
---
##### `code_cov_token_secret`Optional
```python
code_cov_token_secret: str
```
- *Type:* str
- *Default:* if this option is not specified, only public repositories are supported
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
---
##### `copyright_owner`Optional
```python
copyright_owner: str
```
- *Type:* str
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
License copyright owner.
---
##### `copyright_period`Optional
```python
copyright_period: str
```
- *Type:* str
- *Default:* current year
The copyright years to put in the LICENSE file.
---
##### `dependabot`Optional
```python
dependabot: bool
```
- *Type:* bool
- *Default:* false
Use dependabot to handle dependency upgrades.
Cannot be used in conjunction with `depsUpgrade`.
---
##### `dependabot_options`Optional
```python
dependabot_options: DependabotOptions
```
- *Type:* projen.github.DependabotOptions
- *Default:* default options
Options for dependabot.
---
##### `deps_upgrade`Optional
```python
deps_upgrade: bool
```
- *Type:* bool
- *Default:* true
Use github workflows to handle dependency upgrades.
Cannot be used in conjunction with `dependabot`.
---
##### `deps_upgrade_options`Optional
```python
deps_upgrade_options: UpgradeDependenciesOptions
```
- *Type:* projen.javascript.UpgradeDependenciesOptions
- *Default:* default options
Options for `UpgradeDependencies`.
---
##### `gitignore`Optional
```python
gitignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .gitignore.
---
##### `jest`Optional
```python
jest: bool
```
- *Type:* bool
- *Default:* true
Setup jest unit tests.
---
##### `jest_options`Optional
```python
jest_options: JestOptions
```
- *Type:* projen.javascript.JestOptions
- *Default:* default options
Jest options.
---
##### `mutable_build`Optional
```python
mutable_build: bool
```
- *Type:* bool
- *Default:* true
Automatically update files modified during builds to pull-request branches.
This means
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
---
##### ~~`npmignore`~~Optional
- *Deprecated:* - use `project.addPackageIgnore`
```python
npmignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .npmignore.
---
##### `npmignore_enabled`Optional
```python
npmignore_enabled: bool
```
- *Type:* bool
- *Default:* true
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
---
##### `npm_ignore_options`Optional
```python
npm_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .npmignore file.
---
##### `package`Optional
```python
package: bool
```
- *Type:* bool
- *Default:* true
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
---
##### `prettier`Optional
```python
prettier: bool
```
- *Type:* bool
- *Default:* false
Setup prettier.
---
##### `prettier_options`Optional
```python
prettier_options: PrettierOptions
```
- *Type:* projen.javascript.PrettierOptions
- *Default:* default options
Prettier options.
---
##### `projen_dev_dependency`Optional
```python
projen_dev_dependency: bool
```
- *Type:* bool
- *Default:* true
Indicates of "projen" should be installed as a devDependency.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* true if projenrcJson is false
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options for .projenrc.js.
---
##### `projen_version`Optional
```python
projen_version: str
```
- *Type:* str
- *Default:* Defaults to the latest version.
Version of projen to install.
---
##### `pull_request_template`Optional
```python
pull_request_template: bool
```
- *Type:* bool
- *Default:* true
Include a GitHub pull request template.
---
##### `pull_request_template_contents`Optional
```python
pull_request_template_contents: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* default content
The contents of the pull request template.
---
##### `release`Optional
```python
release: bool
```
- *Type:* bool
- *Default:* true (false for subprojects)
Add release management to this project.
---
##### `release_to_npm`Optional
```python
release_to_npm: bool
```
- *Type:* bool
- *Default:* false
Automatically release to npm when new versions are introduced.
---
##### ~~`release_workflow`~~Optional
- *Deprecated:* see `release`.
```python
release_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
DEPRECATED: renamed to `release`.
---
##### `workflow_bootstrap_steps`Optional
```python
workflow_bootstrap_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* "yarn install --frozen-lockfile && yarn projen"
Workflow steps to use in order to bootstrap this repo.
---
##### `workflow_git_identity`Optional
```python
workflow_git_identity: GitIdentity
```
- *Type:* projen.github.GitIdentity
- *Default:* GitHub Actions
The git identity to use in workflows.
---
##### `workflow_node_version`Optional
```python
workflow_node_version: str
```
- *Type:* str
- *Default:* same as `minNodeVersion`
The node version to use in GitHub workflows.
---
##### `workflow_package_cache`Optional
```python
workflow_package_cache: bool
```
- *Type:* bool
- *Default:* false
Enable Node.js package cache in GitHub workflows.
---
##### `disable_tsconfig`Optional
```python
disable_tsconfig: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
---
##### `disable_tsconfig_dev`Optional
```python
disable_tsconfig_dev: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.dev.json` file.
---
##### `docgen`Optional
```python
docgen: bool
```
- *Type:* bool
- *Default:* false
Docgen by Typedoc.
---
##### `docs_directory`Optional
```python
docs_directory: str
```
- *Type:* str
- *Default:* "docs"
Docs directory.
---
##### `entrypoint_types`Optional
```python
entrypoint_types: str
```
- *Type:* str
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
The .d.ts file that includes the type declarations for this module.
---
##### `eslint`Optional
```python
eslint: bool
```
- *Type:* bool
- *Default:* true
Setup eslint.
---
##### `eslint_options`Optional
```python
eslint_options: EslintOptions
```
- *Type:* projen.javascript.EslintOptions
- *Default:* opinionated default options
Eslint options.
---
##### `libdir`Optional
```python
libdir: str
```
- *Type:* str
- *Default:* "lib"
Typescript artifacts output directory.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use TypeScript for your projenrc file (`.projenrc.ts`).
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcOptions
```
- *Type:* projen.typescript.ProjenrcOptions
Options for .projenrc.ts.
---
##### `sample_code`Optional
```python
sample_code: bool
```
- *Type:* bool
- *Default:* true
Generate one-time sample in `src/` and `test/` if there are no files there.
---
##### `srcdir`Optional
```python
srcdir: str
```
- *Type:* str
- *Default:* "src"
Typescript sources directory.
---
##### `testdir`Optional
```python
testdir: str
```
- *Type:* str
- *Default:* "test"
Jest tests directory. Tests files should be named `xxx.test.ts`.
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
then tests are going to be compiled into `lib/` and executed as javascript.
If the test directory is outside of `src`, then we configure jest to
compile the code in-memory.
---
##### `tsconfig`Optional
```python
tsconfig: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* default options
Custom TSConfig.
---
##### `tsconfig_dev`Optional
```python
tsconfig_dev: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* use the production tsconfig options
Custom tsconfig options for the development tsconfig.json file (used for testing).
---
##### `tsconfig_dev_file`Optional
```python
tsconfig_dev_file: str
```
- *Type:* str
- *Default:* "tsconfig.dev.json"
The name of the development tsconfig.json file.
---
##### `typescript_version`Optional
```python
typescript_version: str
```
- *Type:* str
- *Default:* "latest"
TypeScript version to use.
NOTE: Typescript is not semantically versioned and should remain on the
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedTypeScriptRuntimeOptions
Options for configuring a generated typescript runtime project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedTypeScriptRuntimeOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
auto_approve_options: AutoApproveOptions = None,
auto_merge: bool = None,
auto_merge_options: AutoMergeOptions = None,
clobber: bool = None,
dev_container: bool = None,
github: bool = None,
github_options: GitHubOptions = None,
gitpod: bool = None,
mergify: bool = None,
mergify_options: MergifyOptions = None,
project_type: ProjectType = None,
projen_credentials: GithubCredentials = None,
projen_token_secret: str = None,
readme: SampleReadmeProps = None,
stale: bool = None,
stale_options: StaleOptions = None,
vscode: bool = None,
allow_library_dependencies: bool = None,
author_email: str = None,
author_name: str = None,
author_organization: bool = None,
author_url: str = None,
auto_detect_bin: bool = None,
bin: typing.Mapping[str] = None,
bugs_email: str = None,
bugs_url: str = None,
bundled_deps: typing.List[str] = None,
code_artifact_options: CodeArtifactOptions = None,
deps: typing.List[str] = None,
description: str = None,
dev_deps: typing.List[str] = None,
entrypoint: str = None,
homepage: str = None,
keywords: typing.List[str] = None,
license: str = None,
licensed: bool = None,
max_node_version: str = None,
min_node_version: str = None,
npm_access: NpmAccess = None,
npm_registry: str = None,
npm_registry_url: str = None,
npm_token_secret: str = None,
package_manager: NodePackageManager = None,
package_name: str = None,
peer_dependency_options: PeerDependencyOptions = None,
peer_deps: typing.List[str] = None,
pnpm_version: str = None,
repository: str = None,
repository_directory: str = None,
scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
scripts: typing.Mapping[str] = None,
stability: str = None,
jsii_release_version: str = None,
major_version: typing.Union[int, float] = None,
min_major_version: typing.Union[int, float] = None,
npm_dist_tag: str = None,
post_build_steps: typing.List[JobStep] = None,
prerelease: str = None,
publish_dry_run: bool = None,
publish_tasks: bool = None,
release_branches: typing.Mapping[BranchOptions] = None,
release_every_commit: bool = None,
release_failure_issue: bool = None,
release_failure_issue_label: str = None,
release_schedule: str = None,
release_tag_prefix: str = None,
release_trigger: ReleaseTrigger = None,
release_workflow_name: str = None,
release_workflow_setup_steps: typing.List[JobStep] = None,
versionrc_options: typing.Mapping[typing.Any] = None,
workflow_container_image: str = None,
workflow_runs_on: typing.List[str] = None,
default_release_branch: str,
artifacts_directory: str = None,
auto_approve_upgrades: bool = None,
build_workflow: bool = None,
build_workflow_triggers: Triggers = None,
bundler_options: BundlerOptions = None,
code_cov: bool = None,
code_cov_token_secret: str = None,
copyright_owner: str = None,
copyright_period: str = None,
dependabot: bool = None,
dependabot_options: DependabotOptions = None,
deps_upgrade: bool = None,
deps_upgrade_options: UpgradeDependenciesOptions = None,
gitignore: typing.List[str] = None,
jest: bool = None,
jest_options: JestOptions = None,
mutable_build: bool = None,
npmignore: typing.List[str] = None,
npmignore_enabled: bool = None,
npm_ignore_options: IgnoreFileOptions = None,
package: bool = None,
prettier: bool = None,
prettier_options: PrettierOptions = None,
projen_dev_dependency: bool = None,
projenrc_js: bool = None,
projenrc_js_options: ProjenrcOptions = None,
projen_version: str = None,
pull_request_template: bool = None,
pull_request_template_contents: typing.List[str] = None,
release: bool = None,
release_to_npm: bool = None,
release_workflow: bool = None,
workflow_bootstrap_steps: typing.List[JobStep] = None,
workflow_git_identity: GitIdentity = None,
workflow_node_version: str = None,
workflow_package_cache: bool = None,
disable_tsconfig: bool = None,
disable_tsconfig_dev: bool = None,
docgen: bool = None,
docs_directory: str = None,
entrypoint_types: str = None,
eslint: bool = None,
eslint_options: EslintOptions = None,
libdir: str = None,
projenrc_ts: bool = None,
projenrc_ts_options: ProjenrcOptions = None,
sample_code: bool = None,
srcdir: str = None,
testdir: str = None,
tsconfig: TypescriptConfigOptions = None,
tsconfig_dev: TypescriptConfigOptions = None,
tsconfig_dev_file: str = None,
typescript_version: str = None,
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| auto_approve_options | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. |
| auto_merge | bool | Enable automatic merging on GitHub. |
| auto_merge_options | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. |
| clobber | bool | Add a `clobber` task which resets the repo to origin. |
| dev_container | bool | Add a VSCode development environment (used for GitHub Codespaces). |
| github | bool | Enable GitHub integration. |
| github_options | projen.github.GitHubOptions | Options for GitHub integration. |
| gitpod | bool | Add a Gitpod development environment. |
| mergify | bool | Whether mergify should be enabled on this repository or not. |
| mergify_options | projen.github.MergifyOptions | Options for mergify. |
| project_type | projen.ProjectType | Which type of project this is (library/app). |
| projen_credentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. |
| projen_token_secret | str | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
| readme | projen.SampleReadmeProps | The README setup. |
| stale | bool | Auto-close of stale issues and pull request. |
| stale_options | projen.github.StaleOptions | Auto-close stale issues and pull requests. |
| vscode | bool | Enable VSCode integration. |
| allow_library_dependencies | bool | Allow the project to include `peerDependencies` and `bundledDependencies`. |
| author_email | str | Author's e-mail. |
| author_name | str | Author's name. |
| author_organization | bool | Is the author an organization. |
| author_url | str | Author's URL / Website. |
| auto_detect_bin | bool | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
| bin | typing.Mapping[str] | Binary programs vended with your module. |
| bugs_email | str | The email address to which issues should be reported. |
| bugs_url | str | The url to your project's issue tracker. |
| bundled_deps | typing.List[str] | List of dependencies to bundle into this module. |
| code_artifact_options | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. |
| deps | typing.List[str] | Runtime dependencies of this module. |
| description | str | The description is just a string that helps people understand the purpose of the package. |
| dev_deps | typing.List[str] | Build dependencies for this module. |
| entrypoint | str | Module entrypoint (`main` in `package.json`). |
| homepage | str | Package's Homepage / Website. |
| keywords | typing.List[str] | Keywords to include in `package.json`. |
| license | str | License's SPDX identifier. |
| licensed | bool | Indicates if a license should be added. |
| max_node_version | str | Minimum node.js version to require via `engines` (inclusive). |
| min_node_version | str | Minimum Node.js version to require via package.json `engines` (inclusive). |
| npm_access | projen.javascript.NpmAccess | Access level of the npm package. |
| npm_registry | str | The host name of the npm registry to publish to. |
| npm_registry_url | str | The base URL of the npm package registry. |
| npm_token_secret | str | GitHub secret which contains the NPM token to use when publishing packages. |
| package_manager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. |
| package_name | str | The "name" in package.json. |
| peer_dependency_options | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. |
| peer_deps | typing.List[str] | Peer dependencies for this module. |
| pnpm_version | str | The version of PNPM to use if using PNPM as a package manager. |
| repository | str | The repository is the location where the actual code for your package lives. |
| repository_directory | str | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
| scoped_packages_options | typing.List[projen.javascript.ScopedPackagesOptions] | Options for privately hosted scoped packages. |
| scripts | typing.Mapping[str] | npm scripts to include. |
| stability | str | Package's Stability. |
| jsii_release_version | str | Version requirement of `publib` which is used to publish modules to npm. |
| major_version | typing.Union[int, float] | Major version to release from the default branch. |
| min_major_version | typing.Union[int, float] | Minimal Major version to release. |
| npm_dist_tag | str | The npmDistTag to use when publishing from the default branch. |
| post_build_steps | typing.List[projen.github.workflows.JobStep] | Steps to execute after build as part of the release workflow. |
| prerelease | str | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
| publish_dry_run | bool | Instead of actually publishing to package managers, just print the publishing command. |
| publish_tasks | bool | Define publishing tasks that can be executed manually as well as workflows. |
| release_branches | typing.Mapping[projen.release.BranchOptions] | Defines additional release branches. |
| release_every_commit | bool | Automatically release new versions every commit to one of branches in `releaseBranches`. |
| release_failure_issue | bool | Create a github issue on every failed publishing task. |
| release_failure_issue_label | str | The label to apply to issues indicating publish failures. |
| release_schedule | str | CRON schedule to trigger new releases. |
| release_tag_prefix | str | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
| release_trigger | projen.release.ReleaseTrigger | The release trigger to use. |
| release_workflow_name | str | The name of the default release workflow. |
| release_workflow_setup_steps | typing.List[projen.github.workflows.JobStep] | A set of workflow steps to execute in order to setup the workflow container. |
| versionrc_options | typing.Mapping[typing.Any] | Custom configuration used when creating changelog with standard-version package. |
| workflow_container_image | str | Container image to use for GitHub workflows. |
| workflow_runs_on | typing.List[str] | Github Runner selection labels. |
| default_release_branch | str | The name of the main release branch. |
| artifacts_directory | str | A directory which will contain build artifacts. |
| auto_approve_upgrades | bool | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
| build_workflow | bool | Define a GitHub workflow for building PRs. |
| build_workflow_triggers | projen.github.workflows.Triggers | Build workflow triggers. |
| bundler_options | projen.javascript.BundlerOptions | Options for `Bundler`. |
| code_cov | bool | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
| code_cov_token_secret | str | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
| copyright_owner | str | License copyright owner. |
| copyright_period | str | The copyright years to put in the LICENSE file. |
| dependabot | bool | Use dependabot to handle dependency upgrades. |
| dependabot_options | projen.github.DependabotOptions | Options for dependabot. |
| deps_upgrade | bool | Use github workflows to handle dependency upgrades. |
| deps_upgrade_options | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. |
| gitignore | typing.List[str] | Additional entries to .gitignore. |
| jest | bool | Setup jest unit tests. |
| jest_options | projen.javascript.JestOptions | Jest options. |
| mutable_build | bool | Automatically update files modified during builds to pull-request branches. |
| npmignore | typing.List[str] | Additional entries to .npmignore. |
| npmignore_enabled | bool | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
| npm_ignore_options | projen.IgnoreFileOptions | Configuration options for .npmignore file. |
| package | bool | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
| prettier | bool | Setup prettier. |
| prettier_options | projen.javascript.PrettierOptions | Prettier options. |
| projen_dev_dependency | bool | Indicates of "projen" should be installed as a devDependency. |
| projenrc_js | bool | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
| projenrc_js_options | projen.javascript.ProjenrcOptions | Options for .projenrc.js. |
| projen_version | str | Version of projen to install. |
| pull_request_template | bool | Include a GitHub pull request template. |
| pull_request_template_contents | typing.List[str] | The contents of the pull request template. |
| release | bool | Add release management to this project. |
| release_to_npm | bool | Automatically release to npm when new versions are introduced. |
| release_workflow | bool | DEPRECATED: renamed to `release`. |
| workflow_bootstrap_steps | typing.List[projen.github.workflows.JobStep] | Workflow steps to use in order to bootstrap this repo. |
| workflow_git_identity | projen.github.GitIdentity | The git identity to use in workflows. |
| workflow_node_version | str | The node version to use in GitHub workflows. |
| workflow_package_cache | bool | Enable Node.js package cache in GitHub workflows. |
| disable_tsconfig | bool | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
| disable_tsconfig_dev | bool | Do not generate a `tsconfig.dev.json` file. |
| docgen | bool | Docgen by Typedoc. |
| docs_directory | str | Docs directory. |
| entrypoint_types | str | The .d.ts file that includes the type declarations for this module. |
| eslint | bool | Setup eslint. |
| eslint_options | projen.javascript.EslintOptions | Eslint options. |
| libdir | str | Typescript artifacts output directory. |
| projenrc_ts | bool | Use TypeScript for your projenrc file (`.projenrc.ts`). |
| projenrc_ts_options | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. |
| sample_code | bool | Generate one-time sample in `src/` and `test/` if there are no files there. |
| srcdir | str | Typescript sources directory. |
| testdir | str | Jest tests directory. Tests files should be named `xxx.test.ts`. |
| tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. |
| tsconfig_dev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). |
| tsconfig_dev_file | str | The name of the development tsconfig.json file. |
| typescript_version | str | TypeScript version to use. |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `auto_approve_options`Optional
```python
auto_approve_options: AutoApproveOptions
```
- *Type:* projen.github.AutoApproveOptions
- *Default:* auto approve is disabled
Enable and configure the 'auto approve' workflow.
---
##### `auto_merge`Optional
```python
auto_merge: bool
```
- *Type:* bool
- *Default:* true
Enable automatic merging on GitHub.
Has no effect if `github.mergify`
is set to false.
---
##### `auto_merge_options`Optional
```python
auto_merge_options: AutoMergeOptions
```
- *Type:* projen.github.AutoMergeOptions
- *Default:* see defaults in `AutoMergeOptions`
Configure options for automatic merging on GitHub.
Has no effect if
`github.mergify` or `autoMerge` is set to false.
---
##### `clobber`Optional
```python
clobber: bool
```
- *Type:* bool
- *Default:* true, but false for subprojects
Add a `clobber` task which resets the repo to origin.
---
##### `dev_container`Optional
```python
dev_container: bool
```
- *Type:* bool
- *Default:* false
Add a VSCode development environment (used for GitHub Codespaces).
---
##### `github`Optional
```python
github: bool
```
- *Type:* bool
- *Default:* true
Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `github_options`Optional
```python
github_options: GitHubOptions
```
- *Type:* projen.github.GitHubOptions
- *Default:* see GitHubOptions
Options for GitHub integration.
---
##### `gitpod`Optional
```python
gitpod: bool
```
- *Type:* bool
- *Default:* false
Add a Gitpod development environment.
---
##### ~~`mergify`~~Optional
- *Deprecated:* use `githubOptions.mergify` instead
```python
mergify: bool
```
- *Type:* bool
- *Default:* true
Whether mergify should be enabled on this repository or not.
---
##### ~~`mergify_options`~~Optional
- *Deprecated:* use `githubOptions.mergifyOptions` instead
```python
mergify_options: MergifyOptions
```
- *Type:* projen.github.MergifyOptions
- *Default:* default options
Options for mergify.
---
##### ~~`project_type`~~Optional
- *Deprecated:* no longer supported at the base project level
```python
project_type: ProjectType
```
- *Type:* projen.ProjectType
- *Default:* ProjectType.UNKNOWN
Which type of project this is (library/app).
---
##### `projen_credentials`Optional
```python
projen_credentials: GithubCredentials
```
- *Type:* projen.github.GithubCredentials
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
Choose a method of providing GitHub API access for projen workflows.
---
##### ~~`projen_token_secret`~~Optional
- *Deprecated:* use `projenCredentials`
```python
projen_token_secret: str
```
- *Type:* str
- *Default:* "PROJEN_GITHUB_TOKEN"
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
This token needs to have the `repo`, `workflows`
and `packages` scope.
---
##### `readme`Optional
```python
readme: SampleReadmeProps
```
- *Type:* projen.SampleReadmeProps
- *Default:* { filename: 'README.md', contents: '# replace this' }
The README setup.
---
*Example*
```python
"{ filename: 'readme.md', contents: '# title' }"
```
##### `stale`Optional
```python
stale: bool
```
- *Type:* bool
- *Default:* false
Auto-close of stale issues and pull request.
See `staleOptions` for options.
---
##### `stale_options`Optional
```python
stale_options: StaleOptions
```
- *Type:* projen.github.StaleOptions
- *Default:* see defaults in `StaleOptions`
Auto-close stale issues and pull requests.
To disable set `stale` to `false`.
---
##### `vscode`Optional
```python
vscode: bool
```
- *Type:* bool
- *Default:* true
Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.
---
##### `allow_library_dependencies`Optional
```python
allow_library_dependencies: bool
```
- *Type:* bool
- *Default:* true
Allow the project to include `peerDependencies` and `bundledDependencies`.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
---
##### `author_email`Optional
```python
author_email: str
```
- *Type:* str
Author's e-mail.
---
##### `author_name`Optional
```python
author_name: str
```
- *Type:* str
Author's name.
---
##### `author_organization`Optional
```python
author_organization: bool
```
- *Type:* bool
Is the author an organization.
---
##### `author_url`Optional
```python
author_url: str
```
- *Type:* str
Author's URL / Website.
---
##### `auto_detect_bin`Optional
```python
auto_detect_bin: bool
```
- *Type:* bool
- *Default:* true
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
---
##### `bin`Optional
```python
bin: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
Binary programs vended with your module.
You can use this option to add/customize how binaries are represented in
your `package.json`, but unless `autoDetectBin` is `false`, every
executable file under `bin` will automatically be added to this section.
---
##### `bugs_email`Optional
```python
bugs_email: str
```
- *Type:* str
The email address to which issues should be reported.
---
##### `bugs_url`Optional
```python
bugs_url: str
```
- *Type:* str
The url to your project's issue tracker.
---
##### `bundled_deps`Optional
```python
bundled_deps: typing.List[str]
```
- *Type:* typing.List[str]
List of dependencies to bundle into this module.
These modules will be
added both to the `dependencies` section and `bundledDependencies` section of
your `package.json`.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
##### `code_artifact_options`Optional
```python
code_artifact_options: CodeArtifactOptions
```
- *Type:* projen.javascript.CodeArtifactOptions
- *Default:* undefined
Options for npm packages using AWS CodeArtifact.
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
---
##### `deps`Optional
```python
deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Runtime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'express', 'lodash', 'foo@^2' ]
```
##### `description`Optional
```python
description: str
```
- *Type:* str
The description is just a string that helps people understand the purpose of the package.
It can be used when searching for packages in a package manager as well.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
---
##### `dev_deps`Optional
```python
dev_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Build dependencies for this module.
These dependencies will only be
available in your build environment but will not be fetched when this
module is consumed.
The recommendation is to only specify the module name here (e.g.
`express`). This will behave similar to `yarn add` or `npm install` in the
sense that it will add the module as a dependency to your `package.json`
file with the latest version (`^`). You can specify semver requirements in
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
this will be what you `package.json` will eventually include.
---
*Example*
```python
[ 'typescript', '@types/express' ]
```
##### `entrypoint`Optional
```python
entrypoint: str
```
- *Type:* str
- *Default:* "lib/index.js"
Module entrypoint (`main` in `package.json`).
Set to an empty string to not include `main` in your package.json
---
##### `homepage`Optional
```python
homepage: str
```
- *Type:* str
Package's Homepage / Website.
---
##### `keywords`Optional
```python
keywords: typing.List[str]
```
- *Type:* typing.List[str]
Keywords to include in `package.json`.
---
##### `license`Optional
```python
license: str
```
- *Type:* str
- *Default:* "Apache-2.0"
License's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the `licensed` option if you want to no license to be specified.
---
##### `licensed`Optional
```python
licensed: bool
```
- *Type:* bool
- *Default:* true
Indicates if a license should be added.
---
##### `max_node_version`Optional
```python
max_node_version: str
```
- *Type:* str
- *Default:* no max
Minimum node.js version to require via `engines` (inclusive).
---
##### `min_node_version`Optional
```python
min_node_version: str
```
- *Type:* str
- *Default:* no "engines" specified
Minimum Node.js version to require via package.json `engines` (inclusive).
---
##### `npm_access`Optional
```python
npm_access: NpmAccess
```
- *Type:* projen.javascript.NpmAccess
- *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
Access level of the npm package.
---
##### ~~`npm_registry`~~Optional
- *Deprecated:* use `npmRegistryUrl` instead
```python
npm_registry: str
```
- *Type:* str
The host name of the npm registry to publish to.
Cannot be set together with `npmRegistryUrl`.
---
##### `npm_registry_url`Optional
```python
npm_registry_url: str
```
- *Type:* str
- *Default:* "https://registry.npmjs.org"
The base URL of the npm package registry.
Must be a URL (e.g. start with "https://" or "http://")
---
##### `npm_token_secret`Optional
```python
npm_token_secret: str
```
- *Type:* str
- *Default:* "NPM_TOKEN"
GitHub secret which contains the NPM token to use when publishing packages.
---
##### `package_manager`Optional
```python
package_manager: NodePackageManager
```
- *Type:* projen.javascript.NodePackageManager
- *Default:* NodePackageManager.YARN
The Node Package Manager used to execute scripts.
---
##### `package_name`Optional
```python
package_name: str
```
- *Type:* str
- *Default:* defaults to project name
The "name" in package.json.
---
##### `peer_dependency_options`Optional
```python
peer_dependency_options: PeerDependencyOptions
```
- *Type:* projen.javascript.PeerDependencyOptions
Options for `peerDeps`.
---
##### `peer_deps`Optional
```python
peer_deps: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* []
Peer dependencies for this module.
Dependencies listed here are required to
be installed (and satisfied) by the _consumer_ of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the `node_modules` tree of your consumers.
Note that prior to npm@7, peer dependencies are _not_ automatically
installed, which means that adding peer dependencies to a library will be a
breaking change for your customers.
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
---
##### `pnpm_version`Optional
```python
pnpm_version: str
```
- *Type:* str
- *Default:* "7"
The version of PNPM to use if using PNPM as a package manager.
---
##### `repository`Optional
```python
repository: str
```
- *Type:* str
The repository is the location where the actual code for your package lives.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
---
##### `repository_directory`Optional
```python
repository_directory: str
```
- *Type:* str
If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
---
##### `scoped_packages_options`Optional
```python
scoped_packages_options: typing.List[ScopedPackagesOptions]
```
- *Type:* typing.List[projen.javascript.ScopedPackagesOptions]
- *Default:* fetch all scoped packages from the public npm registry
Options for privately hosted scoped packages.
---
##### ~~`scripts`~~Optional
- *Deprecated:* use `project.addTask()` or `package.setScript()`
```python
scripts: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
- *Default:* {}
npm scripts to include.
If a script has the same name as a standard script,
the standard script will be overwritten.
Also adds the script as a task.
---
##### `stability`Optional
```python
stability: str
```
- *Type:* str
Package's Stability.
---
##### `jsii_release_version`Optional
```python
jsii_release_version: str
```
- *Type:* str
- *Default:* "latest"
Version requirement of `publib` which is used to publish modules to npm.
---
##### `major_version`Optional
```python
major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* Major version is not enforced.
Major version to release from the default branch.
If this is specified, we bump the latest version of this major version line.
If not specified, we bump the global latest version.
---
##### `min_major_version`Optional
```python
min_major_version: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* No minimum version is being enforced
Minimal Major version to release.
This can be useful to set to 1, as breaking changes before the 1.x major
release are not incrementing the major version number.
Can not be set together with `majorVersion`.
---
##### `npm_dist_tag`Optional
```python
npm_dist_tag: str
```
- *Type:* str
- *Default:* "latest"
The npmDistTag to use when publishing from the default branch.
To set the npm dist-tag for release branches, set the `npmDistTag` property
for each branch.
---
##### `post_build_steps`Optional
```python
post_build_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* []
Steps to execute after build as part of the release workflow.
---
##### `prerelease`Optional
```python
prerelease: str
```
- *Type:* str
- *Default:* normal semantic versions
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
---
##### `publish_dry_run`Optional
```python
publish_dry_run: bool
```
- *Type:* bool
- *Default:* false
Instead of actually publishing to package managers, just print the publishing command.
---
##### `publish_tasks`Optional
```python
publish_tasks: bool
```
- *Type:* bool
- *Default:* false
Define publishing tasks that can be executed manually as well as workflows.
Normally, publishing only happens within automated workflows. Enable this
in order to create a publishing task for each publishing activity.
---
##### `release_branches`Optional
```python
release_branches: typing.Mapping[BranchOptions]
```
- *Type:* typing.Mapping[projen.release.BranchOptions]
- *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
Defines additional release branches.
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch _must_ be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the `majorVersion` field must also
be provided for the default branch.
---
##### ~~`release_every_commit`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
```python
release_every_commit: bool
```
- *Type:* bool
- *Default:* true
Automatically release new versions every commit to one of branches in `releaseBranches`.
---
##### `release_failure_issue`Optional
```python
release_failure_issue: bool
```
- *Type:* bool
- *Default:* false
Create a github issue on every failed publishing task.
---
##### `release_failure_issue_label`Optional
```python
release_failure_issue_label: str
```
- *Type:* str
- *Default:* "failed-release"
The label to apply to issues indicating publish failures.
Only applies if `releaseFailureIssue` is true.
---
##### ~~`release_schedule`~~Optional
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
```python
release_schedule: str
```
- *Type:* str
- *Default:* no scheduled releases
CRON schedule to trigger new releases.
---
##### `release_tag_prefix`Optional
```python
release_tag_prefix: str
```
- *Type:* str
- *Default:* "v"
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
Note: this prefix is used to detect the latest tagged version
when bumping, so if you change this on a project with an existing version
history, you may need to manually tag your latest release
with the new prefix.
---
##### `release_trigger`Optional
```python
release_trigger: ReleaseTrigger
```
- *Type:* projen.release.ReleaseTrigger
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
The release trigger to use.
---
##### `release_workflow_name`Optional
```python
release_workflow_name: str
```
- *Type:* str
- *Default:* "Release"
The name of the default release workflow.
---
##### `release_workflow_setup_steps`Optional
```python
release_workflow_setup_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
A set of workflow steps to execute in order to setup the workflow container.
---
##### `versionrc_options`Optional
```python
versionrc_options: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
- *Default:* standard configuration applicable for GitHub repositories
Custom configuration used when creating changelog with standard-version package.
Given values either append to default configuration or overwrite values in it.
---
##### `workflow_container_image`Optional
```python
workflow_container_image: str
```
- *Type:* str
- *Default:* default image
Container image to use for GitHub workflows.
---
##### `workflow_runs_on`Optional
```python
workflow_runs_on: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* ["ubuntu-latest"]
Github Runner selection labels.
---
##### `default_release_branch`Required
```python
default_release_branch: str
```
- *Type:* str
- *Default:* "main"
The name of the main release branch.
---
##### `artifacts_directory`Optional
```python
artifacts_directory: str
```
- *Type:* str
- *Default:* "dist"
A directory which will contain build artifacts.
---
##### `auto_approve_upgrades`Optional
```python
auto_approve_upgrades: bool
```
- *Type:* bool
- *Default:* true
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but `autoApproveOptions` are not defined.
---
##### `build_workflow`Optional
```python
build_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
Define a GitHub workflow for building PRs.
---
##### `build_workflow_triggers`Optional
```python
build_workflow_triggers: Triggers
```
- *Type:* projen.github.workflows.Triggers
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
Build workflow triggers.
---
##### `bundler_options`Optional
```python
bundler_options: BundlerOptions
```
- *Type:* projen.javascript.BundlerOptions
Options for `Bundler`.
---
##### `code_cov`Optional
```python
code_cov: bool
```
- *Type:* bool
- *Default:* false
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
---
##### `code_cov_token_secret`Optional
```python
code_cov_token_secret: str
```
- *Type:* str
- *Default:* if this option is not specified, only public repositories are supported
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
---
##### `copyright_owner`Optional
```python
copyright_owner: str
```
- *Type:* str
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
License copyright owner.
---
##### `copyright_period`Optional
```python
copyright_period: str
```
- *Type:* str
- *Default:* current year
The copyright years to put in the LICENSE file.
---
##### `dependabot`Optional
```python
dependabot: bool
```
- *Type:* bool
- *Default:* false
Use dependabot to handle dependency upgrades.
Cannot be used in conjunction with `depsUpgrade`.
---
##### `dependabot_options`Optional
```python
dependabot_options: DependabotOptions
```
- *Type:* projen.github.DependabotOptions
- *Default:* default options
Options for dependabot.
---
##### `deps_upgrade`Optional
```python
deps_upgrade: bool
```
- *Type:* bool
- *Default:* true
Use github workflows to handle dependency upgrades.
Cannot be used in conjunction with `dependabot`.
---
##### `deps_upgrade_options`Optional
```python
deps_upgrade_options: UpgradeDependenciesOptions
```
- *Type:* projen.javascript.UpgradeDependenciesOptions
- *Default:* default options
Options for `UpgradeDependencies`.
---
##### `gitignore`Optional
```python
gitignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .gitignore.
---
##### `jest`Optional
```python
jest: bool
```
- *Type:* bool
- *Default:* true
Setup jest unit tests.
---
##### `jest_options`Optional
```python
jest_options: JestOptions
```
- *Type:* projen.javascript.JestOptions
- *Default:* default options
Jest options.
---
##### `mutable_build`Optional
```python
mutable_build: bool
```
- *Type:* bool
- *Default:* true
Automatically update files modified during builds to pull-request branches.
This means
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
---
##### ~~`npmignore`~~Optional
- *Deprecated:* - use `project.addPackageIgnore`
```python
npmignore: typing.List[str]
```
- *Type:* typing.List[str]
Additional entries to .npmignore.
---
##### `npmignore_enabled`Optional
```python
npmignore_enabled: bool
```
- *Type:* bool
- *Default:* true
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
---
##### `npm_ignore_options`Optional
```python
npm_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .npmignore file.
---
##### `package`Optional
```python
package: bool
```
- *Type:* bool
- *Default:* true
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
---
##### `prettier`Optional
```python
prettier: bool
```
- *Type:* bool
- *Default:* false
Setup prettier.
---
##### `prettier_options`Optional
```python
prettier_options: PrettierOptions
```
- *Type:* projen.javascript.PrettierOptions
- *Default:* default options
Prettier options.
---
##### `projen_dev_dependency`Optional
```python
projen_dev_dependency: bool
```
- *Type:* bool
- *Default:* true
Indicates of "projen" should be installed as a devDependency.
---
##### `projenrc_js`Optional
```python
projenrc_js: bool
```
- *Type:* bool
- *Default:* true if projenrcJson is false
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
---
##### `projenrc_js_options`Optional
```python
projenrc_js_options: ProjenrcOptions
```
- *Type:* projen.javascript.ProjenrcOptions
- *Default:* default options
Options for .projenrc.js.
---
##### `projen_version`Optional
```python
projen_version: str
```
- *Type:* str
- *Default:* Defaults to the latest version.
Version of projen to install.
---
##### `pull_request_template`Optional
```python
pull_request_template: bool
```
- *Type:* bool
- *Default:* true
Include a GitHub pull request template.
---
##### `pull_request_template_contents`Optional
```python
pull_request_template_contents: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* default content
The contents of the pull request template.
---
##### `release`Optional
```python
release: bool
```
- *Type:* bool
- *Default:* true (false for subprojects)
Add release management to this project.
---
##### `release_to_npm`Optional
```python
release_to_npm: bool
```
- *Type:* bool
- *Default:* false
Automatically release to npm when new versions are introduced.
---
##### ~~`release_workflow`~~Optional
- *Deprecated:* see `release`.
```python
release_workflow: bool
```
- *Type:* bool
- *Default:* true if not a subproject
DEPRECATED: renamed to `release`.
---
##### `workflow_bootstrap_steps`Optional
```python
workflow_bootstrap_steps: typing.List[JobStep]
```
- *Type:* typing.List[projen.github.workflows.JobStep]
- *Default:* "yarn install --frozen-lockfile && yarn projen"
Workflow steps to use in order to bootstrap this repo.
---
##### `workflow_git_identity`Optional
```python
workflow_git_identity: GitIdentity
```
- *Type:* projen.github.GitIdentity
- *Default:* GitHub Actions
The git identity to use in workflows.
---
##### `workflow_node_version`Optional
```python
workflow_node_version: str
```
- *Type:* str
- *Default:* same as `minNodeVersion`
The node version to use in GitHub workflows.
---
##### `workflow_package_cache`Optional
```python
workflow_package_cache: bool
```
- *Type:* bool
- *Default:* false
Enable Node.js package cache in GitHub workflows.
---
##### `disable_tsconfig`Optional
```python
disable_tsconfig: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
---
##### `disable_tsconfig_dev`Optional
```python
disable_tsconfig_dev: bool
```
- *Type:* bool
- *Default:* false
Do not generate a `tsconfig.dev.json` file.
---
##### `docgen`Optional
```python
docgen: bool
```
- *Type:* bool
- *Default:* false
Docgen by Typedoc.
---
##### `docs_directory`Optional
```python
docs_directory: str
```
- *Type:* str
- *Default:* "docs"
Docs directory.
---
##### `entrypoint_types`Optional
```python
entrypoint_types: str
```
- *Type:* str
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
The .d.ts file that includes the type declarations for this module.
---
##### `eslint`Optional
```python
eslint: bool
```
- *Type:* bool
- *Default:* true
Setup eslint.
---
##### `eslint_options`Optional
```python
eslint_options: EslintOptions
```
- *Type:* projen.javascript.EslintOptions
- *Default:* opinionated default options
Eslint options.
---
##### `libdir`Optional
```python
libdir: str
```
- *Type:* str
- *Default:* "lib"
Typescript artifacts output directory.
---
##### `projenrc_ts`Optional
```python
projenrc_ts: bool
```
- *Type:* bool
- *Default:* false
Use TypeScript for your projenrc file (`.projenrc.ts`).
---
##### `projenrc_ts_options`Optional
```python
projenrc_ts_options: ProjenrcOptions
```
- *Type:* projen.typescript.ProjenrcOptions
Options for .projenrc.ts.
---
##### `sample_code`Optional
```python
sample_code: bool
```
- *Type:* bool
- *Default:* true
Generate one-time sample in `src/` and `test/` if there are no files there.
---
##### `srcdir`Optional
```python
srcdir: str
```
- *Type:* str
- *Default:* "src"
Typescript sources directory.
---
##### `testdir`Optional
```python
testdir: str
```
- *Type:* str
- *Default:* "test"
Jest tests directory. Tests files should be named `xxx.test.ts`.
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
then tests are going to be compiled into `lib/` and executed as javascript.
If the test directory is outside of `src`, then we configure jest to
compile the code in-memory.
---
##### `tsconfig`Optional
```python
tsconfig: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* default options
Custom TSConfig.
---
##### `tsconfig_dev`Optional
```python
tsconfig_dev: TypescriptConfigOptions
```
- *Type:* projen.javascript.TypescriptConfigOptions
- *Default:* use the production tsconfig options
Custom tsconfig options for the development tsconfig.json file (used for testing).
---
##### `tsconfig_dev_file`Optional
```python
tsconfig_dev_file: str
```
- *Type:* str
- *Default:* "tsconfig.dev.json"
The name of the development tsconfig.json file.
---
##### `typescript_version`Optional
```python
typescript_version: str
```
- *Type:* str
- *Default:* "latest"
TypeScript version to use.
NOTE: Typescript is not semantically versioned and should remain on the
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### GeneratedWithOpenApiGeneratorOptions
Options for a code project generated with OpenAPI Generator.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.GeneratedWithOpenApiGeneratorOptions(
open_api_generator_cli_config: OpenApiGeneratorCliConfig = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_generator_cli_config | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. |
---
##### `open_api_generator_cli_config`Optional
```python
open_api_generator_cli_config: OpenApiGeneratorCliConfig
```
- *Type:* OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
Overrides default values if specified.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
---
### HandlersConfiguration
Configuration for generated lambda handlers.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.HandlersConfiguration(
languages: typing.List[Language],
options: GeneratedHandlersCodeOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| languages | typing.List[Language] | The languages lambda handlers are written in. |
| options | GeneratedHandlersCodeOptions | Options for the infrastructure package. |
---
##### `languages`Required
```python
languages: typing.List[Language]
```
- *Type:* typing.List[Language]
The languages lambda handlers are written in.
Specify multiple languages if you wish to implement different operations
as AWS Lambda functions in different languages.
---
##### `options`Optional
```python
options: GeneratedHandlersCodeOptions
```
- *Type:* GeneratedHandlersCodeOptions
Options for the infrastructure package.
Note that only those provided for the specified language will apply.
---
### InfrastructureConfiguration
Configuration for generated infrastructure.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.InfrastructureConfiguration(
language: Language,
options: GeneratedInfrastructureCodeOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| language | Language | The language to generate the type-safe CDK infrastructure in. |
| options | GeneratedInfrastructureCodeOptions | Options for the infrastructure package. |
---
##### `language`Required
```python
language: Language
```
- *Type:* Language
The language to generate the type-safe CDK infrastructure in.
---
##### `options`Optional
```python
options: GeneratedInfrastructureCodeOptions
```
- *Type:* GeneratedInfrastructureCodeOptions
Options for the infrastructure package.
Note that only those provided for the specified language will apply.
---
### IntegrationGrantProps
Properties for granting the API access to invoke the operation.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.IntegrationGrantProps(
method: str,
path: str,
content_types: typing.List[str] = None,
api: SpecRestApi,
operation_id: str,
scope: Construct
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| method | str | The http method of this operation. |
| path | str | The path of this operation in the api. |
| content_types | typing.List[str] | Content types accepted by this operation. |
| api | aws_cdk.aws_apigateway.SpecRestApi | The api to grant permissions for. |
| operation_id | str | The ID of the operation for which permissions are being granted. |
| scope | constructs.Construct | The scope in which permission resources can be created. |
---
##### `method`Required
```python
method: str
```
- *Type:* str
The http method of this operation.
---
##### `path`Required
```python
path: str
```
- *Type:* str
The path of this operation in the api.
---
##### `content_types`Optional
```python
content_types: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
##### `api`Required
```python
api: SpecRestApi
```
- *Type:* aws_cdk.aws_apigateway.SpecRestApi
The api to grant permissions for.
---
##### `operation_id`Required
```python
operation_id: str
```
- *Type:* str
The ID of the operation for which permissions are being granted.
---
##### `scope`Required
```python
scope: Construct
```
- *Type:* constructs.Construct
The scope in which permission resources can be created.
---
### IntegrationRenderProps
Properties for rendering an integration into an API Gateway OpenAPI extension.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.IntegrationRenderProps(
method: str,
path: str,
content_types: typing.List[str] = None,
operation_id: str,
scope: Construct,
cors_options: SerializedCorsOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| method | str | The http method of this operation. |
| path | str | The path of this operation in the api. |
| content_types | typing.List[str] | Content types accepted by this operation. |
| operation_id | str | The ID of the operation being rendered. |
| scope | constructs.Construct | The scope in which the integration is being rendered. |
| cors_options | SerializedCorsOptions | Cross Origin Resource Sharing options for the API. |
---
##### `method`Required
```python
method: str
```
- *Type:* str
The http method of this operation.
---
##### `path`Required
```python
path: str
```
- *Type:* str
The path of this operation in the api.
---
##### `content_types`Optional
```python
content_types: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
##### `operation_id`Required
```python
operation_id: str
```
- *Type:* str
The ID of the operation being rendered.
---
##### `scope`Required
```python
scope: Construct
```
- *Type:* constructs.Construct
The scope in which the integration is being rendered.
---
##### `cors_options`Optional
```python
cors_options: SerializedCorsOptions
```
- *Type:* SerializedCorsOptions
Cross Origin Resource Sharing options for the API.
---
### LibraryConfiguration
Configuration for generated libraries.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.LibraryConfiguration(
libraries: typing.List[Library],
options: GeneratedLibraryOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| libraries | typing.List[Library] | The library to generate. |
| options | GeneratedLibraryOptions | Options for the generated library package. |
---
##### `libraries`Required
```python
libraries: typing.List[Library]
```
- *Type:* typing.List[Library]
The library to generate.
---
##### `options`Optional
```python
options: GeneratedLibraryOptions
```
- *Type:* GeneratedLibraryOptions
Options for the generated library package.
Note that only options for the specified libraries will apply
---
### ManagedRule
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ManagedRule(
name: str,
vendor: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | The name of the managed rule group. |
| vendor | str | The name of the managed rule group vendor. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
The name of the managed rule group.
You use this, along with the vendor name, to identify the rule group.
---
##### `vendor`Required
```python
vendor: str
```
- *Type:* str
The name of the managed rule group vendor.
You use this, along with the rule group name, to identify the rule group.
---
### MethodAndPath
Structure to contain an API operation's method and path.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.MethodAndPath(
method: str,
path: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| method | str | The http method of this operation. |
| path | str | The path of this operation in the api. |
---
##### `method`Required
```python
method: str
```
- *Type:* str
The http method of this operation.
---
##### `path`Required
```python
path: str
```
- *Type:* str
The path of this operation in the api.
---
### MockIntegrationResponse
Properties for a mock integration response.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.MockIntegrationResponse(
status_code: typing.Union[int, float],
body: str = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| status_code | typing.Union[int, float] | HTTP response status code. |
| body | str | Response body. |
---
##### `status_code`Required
```python
status_code: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
HTTP response status code.
---
##### `body`Optional
```python
body: str
```
- *Type:* str
Response body.
---
### MockResponseDataGenerationOptions
Options for generating mock data.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.MockResponseDataGenerationOptions(
disable: bool = None,
locale: str = None,
max_array_length: typing.Union[int, float] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| disable | bool | Set to true to disable generating mock data. |
| locale | str | Locale of generated data. |
| max_array_length | typing.Union[int, float] | Maximum length of generated arrays. |
---
##### `disable`Optional
```python
disable: bool
```
- *Type:* bool
- *Default:* false
Set to true to disable generating mock data.
---
##### `locale`Optional
```python
locale: str
```
- *Type:* str
- *Default:* en
Locale of generated data.
> [https://fakerjs.dev/guide/localization.html#available-locales](https://fakerjs.dev/guide/localization.html#available-locales)
---
##### `max_array_length`Optional
```python
max_array_length: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
- *Default:* 3
Maximum length of generated arrays.
---
### MockResponseGenerationOptions
Options for generating mock data.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.MockResponseGenerationOptions(
mock_data_options: MockResponseDataGenerationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| mock_data_options | MockResponseDataGenerationOptions | Options for the generated mock response data. |
---
##### `mock_data_options`Optional
```python
mock_data_options: MockResponseDataGenerationOptions
```
- *Type:* MockResponseDataGenerationOptions
Options for the generated mock response data.
---
### ModelConfiguration
Configuration for modelling the API.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ModelConfiguration(
language: ModelLanguage,
options: ModelOptions
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| language | ModelLanguage | The language the API model is defined in. |
| options | ModelOptions | Options for the API model. |
---
##### `language`Required
```python
language: ModelLanguage
```
- *Type:* ModelLanguage
The language the API model is defined in.
---
##### `options`Required
```python
options: ModelOptions
```
- *Type:* ModelOptions
Options for the API model.
---
### ModelOptions
Options for models.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ModelOptions(
openapi: OpenApiModelOptions = None,
smithy: SmithyModelOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| openapi | OpenApiModelOptions | Options for the OpenAPI model - required when model language is OPENAPI. |
| smithy | SmithyModelOptions | Options for the Smithy model - required when model language is SMITHY. |
---
##### `openapi`Optional
```python
openapi: OpenApiModelOptions
```
- *Type:* OpenApiModelOptions
Options for the OpenAPI model - required when model language is OPENAPI.
---
##### `smithy`Optional
```python
smithy: SmithyModelOptions
```
- *Type:* SmithyModelOptions
Options for the Smithy model - required when model language is SMITHY.
---
### OpenApiDefinitionOptions
Options for the OpenAPI Spec.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OpenApiDefinitionOptions(
open_api_options: OpenApiModelOptions,
handler_languages: typing.List[Language] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| open_api_options | OpenApiModelOptions | Options for the openapi model. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `open_api_options`Required
```python
open_api_options: OpenApiModelOptions
```
- *Type:* OpenApiModelOptions
Options for the openapi model.
---
##### `handler_languages`Optional
```python
handler_languages: typing.List[Language]
```
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
### OpenApiGeneratorCliConfig
Configuration for the OpenAPI Generator CLI.
> [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OpenApiGeneratorCliConfig(
repository: OpenApiGeneratorCliConfigRepository = None,
storage_dir: str = None,
use_docker: bool = None,
version: str = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| repository | OpenApiGeneratorCliConfigRepository | Maven repository info for fetching the OpenAPI Generator jar. |
| storage_dir | str | The directory in which OpenAPI Generator jars are cached. |
| use_docker | bool | Use docker instead of your locally installed Java version. |
| version | str | OpenAPI Generator version to use. |
---
##### `repository`Optional
```python
repository: OpenApiGeneratorCliConfigRepository
```
- *Type:* OpenApiGeneratorCliConfigRepository
- *Default:* public maven repository
Maven repository info for fetching the OpenAPI Generator jar.
> [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry)
---
##### `storage_dir`Optional
```python
storage_dir: str
```
- *Type:* str
- *Default:* ~/.open-api-generator-cli
The directory in which OpenAPI Generator jars are cached.
---
##### `use_docker`Optional
```python
use_docker: bool
```
- *Type:* bool
- *Default:* false
Use docker instead of your locally installed Java version.
> [https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally](https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally)
---
##### `version`Optional
```python
version: str
```
- *Type:* str
- *Default:* 6.3.0
OpenAPI Generator version to use.
Edit with caution - using the non-default
version may result in broken generated code.
---
### OpenApiGeneratorCliConfigRepository
Maven repository info for fetching the OpenAPI Generator jar.
> [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OpenApiGeneratorCliConfigRepository(
download_url: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| download_url | str | Maven repository URL for downloading the OpenAPI Generator jar. |
---
##### `download_url`Required
```python
download_url: str
```
- *Type:* str
Maven repository URL for downloading the OpenAPI Generator jar.
This must specify the full url, and can include placeholders for the groupId, artifactId and versionName.
For example: https://private.maven.intern/maven2/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar
> [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry)
---
### OpenApiModelOptions
Options for the OpenAPI model.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OpenApiModelOptions(
title: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| title | str | The title in the OpenAPI specification. |
---
##### `title`Required
```python
title: str
```
- *Type:* str
The title in the OpenAPI specification.
---
### OperationDetails
Details about an API operation.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OperationDetails(
method: str,
path: str,
content_types: typing.List[str] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| method | str | The http method of this operation. |
| path | str | The path of this operation in the api. |
| content_types | typing.List[str] | Content types accepted by this operation. |
---
##### `method`Required
```python
method: str
```
- *Type:* str
The http method of this operation.
---
##### `path`Required
```python
path: str
```
- *Type:* str
The path of this operation in the api.
---
##### `content_types`Optional
```python
content_types: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
### ProjectCollections
Collections of projects managed by type-safe-api.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.ProjectCollections(
documentation: typing.List[Project],
handlers: typing.List[Project],
infrastructure: typing.List[Project],
libraries: typing.List[Project],
model: typing.List[Project],
projects: typing.List[Project],
runtimes: typing.List[Project]
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| documentation | typing.List[projen.Project] | Array of all documentation projects. |
| handlers | typing.List[projen.Project] | Array of all handler projects. |
| infrastructure | typing.List[projen.Project] | Array of all infrastructure projects. |
| libraries | typing.List[projen.Project] | Array of all library projects. |
| model | typing.List[projen.Project] | Array of all model projects. |
| projects | typing.List[projen.Project] | Array of all projects managed by type-safe-api. |
| runtimes | typing.List[projen.Project] | Array of all runtime projects. |
---
##### `documentation`Required
```python
documentation: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all documentation projects.
---
##### `handlers`Required
```python
handlers: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all handler projects.
---
##### `infrastructure`Required
```python
infrastructure: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all infrastructure projects.
---
##### `libraries`Required
```python
libraries: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all library projects.
---
##### `model`Required
```python
model: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all model projects.
---
##### `projects`Required
```python
projects: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all projects managed by type-safe-api.
---
##### `runtimes`Required
```python
runtimes: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Array of all runtime projects.
---
### RuntimeConfiguration
Configuration for generated runtime projects.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.RuntimeConfiguration(
languages: typing.List[Language],
options: GeneratedRuntimeCodeOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| languages | typing.List[Language] | The languages that runtime projects will be generated in. |
| options | GeneratedRuntimeCodeOptions | Options for the generated runtimes. |
---
##### `languages`Required
```python
languages: typing.List[Language]
```
- *Type:* typing.List[Language]
The languages that runtime projects will be generated in.
These projects can be used to provide type safety for
both client and server projects.
---
##### `options`Optional
```python
options: GeneratedRuntimeCodeOptions
```
- *Type:* GeneratedRuntimeCodeOptions
Options for the generated runtimes.
Note that only options provided for the specified languages will apply.
---
### SerializedCorsOptions
Cross-origin resource sharing options.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SerializedCorsOptions(
allow_headers: typing.List[str],
allow_methods: typing.List[str],
allow_origins: typing.List[str],
status_code: typing.Union[int, float]
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| allow_headers | typing.List[str] | Headers to allow. |
| allow_methods | typing.List[str] | HTTP methods to allow. |
| allow_origins | typing.List[str] | Origins to allow. |
| status_code | typing.Union[int, float] | HTTP status code to be returned by preflight requests. |
---
##### `allow_headers`Required
```python
allow_headers: typing.List[str]
```
- *Type:* typing.List[str]
Headers to allow.
---
##### `allow_methods`Required
```python
allow_methods: typing.List[str]
```
- *Type:* typing.List[str]
HTTP methods to allow.
---
##### `allow_origins`Required
```python
allow_origins: typing.List[str]
```
- *Type:* typing.List[str]
Origins to allow.
---
##### `status_code`Required
```python
status_code: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
HTTP status code to be returned by preflight requests.
---
### SmithyBuildOptions
Options for the smithy build files.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyBuildOptions(
imports: typing.List[str] = None,
plugins: typing.Mapping[typing.Mapping[typing.Any]] = None,
additional_sources: typing.List[str] = None,
ignore_missing_plugins: bool = None,
maven: SmithyMavenConfiguration = None,
projections: typing.Mapping[SmithyProjection] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| imports | typing.List[str] | List of imports. |
| plugins | typing.Mapping[typing.Mapping[typing.Any]] | Plugins keyed by plugin id. |
| additional_sources | typing.List[str] | Paths to any additional model files or directories to be used as sources for the smithy build. |
| ignore_missing_plugins | bool | If a plugin can't be found, Smithy will by default fail the build. |
| maven | SmithyMavenConfiguration | Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files. |
| projections | typing.Mapping[SmithyProjection] | Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections. |
---
##### `imports`Optional
```python
imports: typing.List[str]
```
- *Type:* typing.List[str]
List of imports.
---
##### `plugins`Optional
```python
plugins: typing.Mapping[typing.Mapping[typing.Any]]
```
- *Type:* typing.Mapping[typing.Mapping[typing.Any]]
Plugins keyed by plugin id.
---
##### `additional_sources`Optional
```python
additional_sources: typing.List[str]
```
- *Type:* typing.List[str]
Paths to any additional model files or directories to be used as sources for the smithy build.
The src/main/smithy directory is always included.
Paths must be relative to the model project directory. Absolute paths will
be resolved as relative paths.
---
##### `ignore_missing_plugins`Optional
```python
ignore_missing_plugins: bool
```
- *Type:* bool
- *Default:* no ignoreMissingPlugins set in the smithy-build.json file
If a plugin can't be found, Smithy will by default fail the build.
This setting can be set to true to allow the build to progress
even if a plugin can't be found on the classpath.
---
##### `maven`Optional
```python
maven: SmithyMavenConfiguration
```
- *Type:* SmithyMavenConfiguration
- *Default:* the default configuration required for Smithy to OpenAPI conversion
Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files.
---
##### `projections`Optional
```python
projections: typing.Mapping[SmithyProjection]
```
- *Type:* typing.Mapping[SmithyProjection]
- *Default:* no projections
Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections.
---
### SmithyCommon
Properties common to smithy plugins and the root smithy build.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyCommon(
imports: typing.List[str] = None,
plugins: typing.Mapping[typing.Mapping[typing.Any]] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| imports | typing.List[str] | List of imports. |
| plugins | typing.Mapping[typing.Mapping[typing.Any]] | Plugins keyed by plugin id. |
---
##### `imports`Optional
```python
imports: typing.List[str]
```
- *Type:* typing.List[str]
List of imports.
---
##### `plugins`Optional
```python
plugins: typing.Mapping[typing.Mapping[typing.Any]]
```
- *Type:* typing.Mapping[typing.Mapping[typing.Any]]
Plugins keyed by plugin id.
---
### SmithyDefinitionOptions
Options for a smithy build project.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyDefinitionOptions(
smithy_options: SmithyModelOptions,
handler_languages: typing.List[Language] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| smithy_options | SmithyModelOptions | Smithy engine options. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `smithy_options`Required
```python
smithy_options: SmithyModelOptions
```
- *Type:* SmithyModelOptions
Smithy engine options.
---
##### `handler_languages`Optional
```python
handler_languages: typing.List[Language]
```
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
### SmithyMavenConfiguration
Configuration for smithy maven dependencies.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyMavenConfiguration(
dependencies: typing.List[str] = None,
repository_urls: typing.List[str] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| dependencies | typing.List[str] | The dependencies used in the build.gradle and smithy-build.json files eg. software.amazon.smithy:smithy-validation-model:1.28.0 The following required dependencies are always added: - software.amazon.smithy:smithy-cli:1.28.0 - software.amazon.smithy:smithy-model:1.28.0 - software.amazon.smithy:smithy-openapi:1.28.0 - software.amazon.smithy:smithy-aws-traits:1.28.0 You can however override the version of these dependencies if required. |
| repository_urls | typing.List[str] | The repository urls used in the build.gradle and smithy-build.json files. |
---
##### `dependencies`Optional
```python
dependencies: typing.List[str]
```
- *Type:* typing.List[str]
The dependencies used in the build.gradle and smithy-build.json files eg. software.amazon.smithy:smithy-validation-model:1.28.0 The following required dependencies are always added: - software.amazon.smithy:smithy-cli:1.28.0 - software.amazon.smithy:smithy-model:1.28.0 - software.amazon.smithy:smithy-openapi:1.28.0 - software.amazon.smithy:smithy-aws-traits:1.28.0 You can however override the version of these dependencies if required.
---
##### `repository_urls`Optional
```python
repository_urls: typing.List[str]
```
- *Type:* typing.List[str]
- *Default:* maven central and maven local
The repository urls used in the build.gradle and smithy-build.json files.
---
### SmithyModelOptions
Options for a Smithy model.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyModelOptions(
service_name: SmithyServiceName,
ignore_gradle_wrapper: bool = None,
ignore_smithy_build_output: bool = None,
smithy_build_options: SmithyBuildOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| service_name | SmithyServiceName | Smithy service name. |
| ignore_gradle_wrapper | bool | Set to false if you would like to check in your gradle wrapper. |
| ignore_smithy_build_output | bool | Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file. |
| smithy_build_options | SmithyBuildOptions | Smithy build options. |
---
##### `service_name`Required
```python
service_name: SmithyServiceName
```
- *Type:* SmithyServiceName
Smithy service name.
---
##### `ignore_gradle_wrapper`Optional
```python
ignore_gradle_wrapper: bool
```
- *Type:* bool
- *Default:* true
Set to false if you would like to check in your gradle wrapper.
Do so if you would like to use a different version
of gradle to the one provided by default
---
##### `ignore_smithy_build_output`Optional
```python
ignore_smithy_build_output: bool
```
- *Type:* bool
- *Default:* true
Set to false if you would like to check in your smithy build output or have more fine-grained control over what is checked in, eg if you add other projections to the smithy-build.json file.
---
##### `smithy_build_options`Optional
```python
smithy_build_options: SmithyBuildOptions
```
- *Type:* SmithyBuildOptions
Smithy build options.
---
### SmithyProjection
A smithy build projection.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyProjection(
imports: typing.List[str] = None,
plugins: typing.Mapping[typing.Mapping[typing.Any]] = None,
abstract: bool = None,
transforms: typing.List[SmithyTransform] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| imports | typing.List[str] | List of imports. |
| plugins | typing.Mapping[typing.Mapping[typing.Any]] | Plugins keyed by plugin id. |
| abstract | bool | Whether or not the projection is abstract. |
| transforms | typing.List[SmithyTransform] | Transforms to apply to the projection. |
---
##### `imports`Optional
```python
imports: typing.List[str]
```
- *Type:* typing.List[str]
List of imports.
---
##### `plugins`Optional
```python
plugins: typing.Mapping[typing.Mapping[typing.Any]]
```
- *Type:* typing.Mapping[typing.Mapping[typing.Any]]
Plugins keyed by plugin id.
---
##### `abstract`Optional
```python
abstract: bool
```
- *Type:* bool
Whether or not the projection is abstract.
---
##### `transforms`Optional
```python
transforms: typing.List[SmithyTransform]
```
- *Type:* typing.List[SmithyTransform]
Transforms to apply to the projection.
---
### SmithyServiceName
Represents a fully qualified name of a Smithy service.
> [https://awslabs.github.io/smithy/2.0/spec/service-types.html](https://awslabs.github.io/smithy/2.0/spec/service-types.html)
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyServiceName(
namespace: str,
service_name: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| namespace | str | The service namespace. |
| service_name | str | The service name. |
---
##### `namespace`Required
```python
namespace: str
```
- *Type:* str
The service namespace.
Nested namespaces are separated by '.', for example com.company
> [https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id](https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id)
---
##### `service_name`Required
```python
service_name: str
```
- *Type:* str
The service name.
Should be PascalCase, for example HelloService
> [https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id](https://awslabs.github.io/smithy/2.0/spec/model.html#shape-id)
---
### SmithyTransform
A smithy build transform.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyTransform(
args: typing.Mapping[typing.Any],
name: str
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| args | typing.Mapping[typing.Any] | Arguments for the transform. |
| name | str | Name of the transform. |
---
##### `args`Required
```python
args: typing.Mapping[typing.Any]
```
- *Type:* typing.Mapping[typing.Any]
Arguments for the transform.
---
##### `name`Required
```python
name: str
```
- *Type:* str
Name of the transform.
---
### TypeSafeApiIntegration
Defines an integration for an individual API operation.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiIntegration(
integration: Integration,
authorizer: Authorizer = None,
options: TypeSafeApiIntegrationOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| integration | Integration | The integration to service the api operation. |
| authorizer | Authorizer | The authorizer to use for this api operation (overrides the default). |
| options | TypeSafeApiIntegrationOptions | Options for the integration. |
---
##### `integration`Required
```python
integration: Integration
```
- *Type:* Integration
The integration to service the api operation.
---
##### `authorizer`Optional
```python
authorizer: Authorizer
```
- *Type:* Authorizer
The authorizer to use for this api operation (overrides the default).
---
##### `options`Optional
```python
options: TypeSafeApiIntegrationOptions
```
- *Type:* TypeSafeApiIntegrationOptions
Options for the integration.
---
### TypeSafeApiIntegrationOptions
Options for an integration.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiIntegrationOptions(
api_key_required: bool = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| api_key_required | bool | Require an API key to invoke this operation. |
---
##### `api_key_required`Optional
```python
api_key_required: bool
```
- *Type:* bool
- *Default:* false
Require an API key to invoke this operation.
Overrides the default setting if present.
This is only applicable when the API key source is HEADER.
---
### TypeSafeApiModelProjectOptions
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiModelProjectOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
model_language: ModelLanguage,
model_options: ModelOptions,
handler_languages: typing.List[Language] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| model_language | ModelLanguage | Language the model is defined in. |
| model_options | ModelOptions | Options for the model. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `model_language`Required
```python
model_language: ModelLanguage
```
- *Type:* ModelLanguage
Language the model is defined in.
---
##### `model_options`Required
```python
model_options: ModelOptions
```
- *Type:* ModelOptions
Options for the model.
---
##### `handler_languages`Optional
```python
handler_languages: typing.List[Language]
```
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
### TypeSafeApiOptions
Options required alongside an Open API specification to create API Gateway resources.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiOptions(
integrations: typing.Mapping[TypeSafeApiIntegration],
operation_lookup: typing.Mapping[OperationDetails],
api_key_options: ApiKeyOptions = None,
cors_options: CorsOptions = None,
default_authorizer: Authorizer = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| integrations | typing.Mapping[TypeSafeApiIntegration] | A mapping of API operation to its integration. |
| operation_lookup | typing.Mapping[OperationDetails] | Details about each operation. |
| api_key_options | ApiKeyOptions | Options for API keys. |
| cors_options | aws_cdk.aws_apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. |
| default_authorizer | Authorizer | The default authorizer to use for your api. |
---
##### `integrations`Required
```python
integrations: typing.Mapping[TypeSafeApiIntegration]
```
- *Type:* typing.Mapping[TypeSafeApiIntegration]
A mapping of API operation to its integration.
---
##### `operation_lookup`Required
```python
operation_lookup: typing.Mapping[OperationDetails]
```
- *Type:* typing.Mapping[OperationDetails]
Details about each operation.
---
##### `api_key_options`Optional
```python
api_key_options: ApiKeyOptions
```
- *Type:* ApiKeyOptions
Options for API keys.
---
##### `cors_options`Optional
```python
cors_options: CorsOptions
```
- *Type:* aws_cdk.aws_apigateway.CorsOptions
Cross Origin Resource Sharing options for the API.
---
##### `default_authorizer`Optional
```python
default_authorizer: Authorizer
```
- *Type:* Authorizer
The default authorizer to use for your api.
When omitted, no default authorizer is used.
Authorizers specified at the integration level will override this for that operation.
---
### TypeSafeApiProjectOptions
Options for the TypeSafeApiProject.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiProjectOptions(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
infrastructure: InfrastructureConfiguration,
model: ModelConfiguration,
runtime: RuntimeConfiguration,
documentation: DocumentationConfiguration = None,
handlers: HandlersConfiguration = None,
library: LibraryConfiguration = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| infrastructure | InfrastructureConfiguration | Configuration for generated infrastructure. |
| model | ModelConfiguration | Configuration for the API model. |
| runtime | RuntimeConfiguration | Configuration for generated runtime projects (containing types, clients and server code). |
| documentation | DocumentationConfiguration | Configuration for generated documentation. |
| handlers | HandlersConfiguration | Configuration for lambda handlers for implementing the API. |
| library | LibraryConfiguration | Configuration for generated libraries. |
---
##### `name`Required
```python
name: str
```
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
```python
commit_generated: bool
```
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
```python
git_ignore_options: IgnoreFileOptions
```
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
```python
git_options: GitOptions
```
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
```python
logging: LoggerOptions
```
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
```python
outdir: str
```
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
```python
projen_command: str
```
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
```python
projenrc_json: bool
```
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
```python
projenrc_json_options: ProjenrcJsonOptions
```
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
```python
renovatebot: bool
```
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
```python
renovatebot_options: RenovatebotOptions
```
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `infrastructure`Required
```python
infrastructure: InfrastructureConfiguration
```
- *Type:* InfrastructureConfiguration
Configuration for generated infrastructure.
---
##### `model`Required
```python
model: ModelConfiguration
```
- *Type:* ModelConfiguration
Configuration for the API model.
---
##### `runtime`Required
```python
runtime: RuntimeConfiguration
```
- *Type:* RuntimeConfiguration
Configuration for generated runtime projects (containing types, clients and server code).
---
##### `documentation`Optional
```python
documentation: DocumentationConfiguration
```
- *Type:* DocumentationConfiguration
Configuration for generated documentation.
---
##### `handlers`Optional
```python
handlers: HandlersConfiguration
```
- *Type:* HandlersConfiguration
Configuration for lambda handlers for implementing the API.
---
##### `library`Optional
```python
library: LibraryConfiguration
```
- *Type:* LibraryConfiguration
Configuration for generated libraries.
Libraries are projects which are generated from your model, but are not
fully-fledged runtimes, for example react hooks or clients in languages that aren't supported as runtimes.
---
### TypeSafeApiWebAclOptions
Configuration for the Web ACL associated with the API.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiWebAclOptions(
cidr_allow_list: CidrAllowList = None,
disable: bool = None,
managed_rules: typing.List[ManagedRule] = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cidr_allow_list | CidrAllowList | List of cidr ranges to allow. |
| disable | bool | If set to true, no WebACL will be associated with the API. |
| managed_rules | typing.List[ManagedRule] | List of managed rules to apply to the web acl. |
---
##### `cidr_allow_list`Optional
```python
cidr_allow_list: CidrAllowList
```
- *Type:* CidrAllowList
- *Default:* undefined
List of cidr ranges to allow.
---
##### `disable`Optional
```python
disable: bool
```
- *Type:* bool
- *Default:* false
If set to true, no WebACL will be associated with the API.
You can also use this option if you would like to create
your own WebACL and associate it yourself.
---
##### `managed_rules`Optional
```python
managed_rules: typing.List[ManagedRule]
```
- *Type:* typing.List[ManagedRule]
- *Default:* [{ vendor: "AWS", name: "AWSManagedRulesCommonRuleSet" }]
List of managed rules to apply to the web acl.
---
### TypeSafeRestApiProps
Configuration for the TypeSafeRestApi construct.
#### Initializer
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeRestApiProps(
cloud_watch_role: bool = None,
deploy: bool = None,
deploy_options: StageOptions = None,
description: str = None,
disable_execute_api_endpoint: bool = None,
domain_name: DomainNameOptions = None,
endpoint_export_name: str = None,
endpoint_types: typing.List[EndpointType] = None,
fail_on_warnings: bool = None,
parameters: typing.Mapping[str] = None,
policy: PolicyDocument = None,
rest_api_name: str = None,
retain_deployments: bool = None,
integrations: typing.Mapping[TypeSafeApiIntegration],
operation_lookup: typing.Mapping[OperationDetails],
api_key_options: ApiKeyOptions = None,
cors_options: CorsOptions = None,
default_authorizer: Authorizer = None,
spec_path: str,
min_compression_size: Size = None,
web_acl_options: TypeSafeApiWebAclOptions = None
)
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cloud_watch_role | bool | Automatically configure an AWS CloudWatch role for API Gateway. |
| deploy | bool | Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. |
| deploy_options | aws_cdk.aws_apigateway.StageOptions | Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. |
| description | str | A description of the RestApi construct. |
| disable_execute_api_endpoint | bool | Specifies whether clients can invoke the API using the default execute-api endpoint. |
| domain_name | aws_cdk.aws_apigateway.DomainNameOptions | Configure a custom domain name and map it to this API. |
| endpoint_export_name | str | Export name for the CfnOutput containing the API endpoint. |
| endpoint_types | typing.List[aws_cdk.aws_apigateway.EndpointType] | A list of the endpoint types of the API. |
| fail_on_warnings | bool | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. |
| parameters | typing.Mapping[str] | Custom header parameters for the request. |
| policy | aws_cdk.aws_iam.PolicyDocument | A policy document that contains the permissions for this RestApi. |
| rest_api_name | str | A name for the API Gateway RestApi resource. |
| retain_deployments | bool | Retains old deployment resources when the API changes. |
| integrations | typing.Mapping[TypeSafeApiIntegration] | A mapping of API operation to its integration. |
| operation_lookup | typing.Mapping[OperationDetails] | Details about each operation. |
| api_key_options | ApiKeyOptions | Options for API keys. |
| cors_options | aws_cdk.aws_apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. |
| default_authorizer | Authorizer | The default authorizer to use for your api. |
| spec_path | str | Path to the JSON open api spec. |
| min_compression_size | aws_cdk.Size | A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. |
| web_acl_options | TypeSafeApiWebAclOptions | Options for the AWS WAF v2 WebACL associated with the api. |
---
##### `cloud_watch_role`Optional
```python
cloud_watch_role: bool
```
- *Type:* bool
- *Default:* false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise
Automatically configure an AWS CloudWatch role for API Gateway.
---
##### `deploy`Optional
```python
deploy: bool
```
- *Type:* bool
- *Default:* true
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
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.
---
##### `deploy_options`Optional
```python
deploy_options: StageOptions
```
- *Type:* aws_cdk.aws_apigateway.StageOptions
- *Default:* Based on defaults of `StageOptions`.
Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
If `deploy` is disabled,
this value cannot be set.
---
##### `description`Optional
```python
description: str
```
- *Type:* str
- *Default:* 'Automatically created by the RestApi construct'
A description of the RestApi construct.
---
##### `disable_execute_api_endpoint`Optional
```python
disable_execute_api_endpoint: bool
```
- *Type:* bool
- *Default:* false
Specifies whether clients can invoke the API using the default execute-api endpoint.
To require that clients use a custom domain name to invoke the
API, disable the default endpoint.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)
---
##### `domain_name`Optional
```python
domain_name: DomainNameOptions
```
- *Type:* aws_cdk.aws_apigateway.DomainNameOptions
- *Default:* no domain name is defined, use `addDomainName` or directly define a `DomainName`.
Configure a custom domain name and map it to this API.
---
##### `endpoint_export_name`Optional
```python
endpoint_export_name: str
```
- *Type:* str
- *Default:* when no export name is given, output will be created without export
Export name for the CfnOutput containing the API endpoint.
---
##### `endpoint_types`Optional
```python
endpoint_types: typing.List[EndpointType]
```
- *Type:* typing.List[aws_cdk.aws_apigateway.EndpointType]
- *Default:* EndpointType.EDGE
A list of the endpoint types of the API.
Use this property when creating
an API.
---
##### `fail_on_warnings`Optional
```python
fail_on_warnings: bool
```
- *Type:* bool
- *Default:* false
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
---
##### `parameters`Optional
```python
parameters: typing.Mapping[str]
```
- *Type:* typing.Mapping[str]
- *Default:* No parameters.
Custom header parameters for the request.
> [https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html)
---
##### `policy`Optional
```python
policy: PolicyDocument
```
- *Type:* aws_cdk.aws_iam.PolicyDocument
- *Default:* No policy.
A policy document that contains the permissions for this RestApi.
---
##### `rest_api_name`Optional
```python
rest_api_name: str
```
- *Type:* str
- *Default:* ID of the RestApi construct.
A name for the API Gateway RestApi resource.
---
##### `retain_deployments`Optional
```python
retain_deployments: bool
```
- *Type:* bool
- *Default:* false
Retains old deployment resources when the API changes.
This allows
manually reverting stages to point to old deployments via the AWS
Console.
---
##### `integrations`Required
```python
integrations: typing.Mapping[TypeSafeApiIntegration]
```
- *Type:* typing.Mapping[TypeSafeApiIntegration]
A mapping of API operation to its integration.
---
##### `operation_lookup`Required
```python
operation_lookup: typing.Mapping[OperationDetails]
```
- *Type:* typing.Mapping[OperationDetails]
Details about each operation.
---
##### `api_key_options`Optional
```python
api_key_options: ApiKeyOptions
```
- *Type:* ApiKeyOptions
Options for API keys.
---
##### `cors_options`Optional
```python
cors_options: CorsOptions
```
- *Type:* aws_cdk.aws_apigateway.CorsOptions
Cross Origin Resource Sharing options for the API.
---
##### `default_authorizer`Optional
```python
default_authorizer: Authorizer
```
- *Type:* Authorizer
The default authorizer to use for your api.
When omitted, no default authorizer is used.
Authorizers specified at the integration level will override this for that operation.
---
##### `spec_path`Required
```python
spec_path: str
```
- *Type:* str
Path to the JSON open api spec.
---
##### `min_compression_size`Optional
```python
min_compression_size: Size
```
- *Type:* aws_cdk.Size
- *Default:* Compression is disabled.
A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
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.
---
##### `web_acl_options`Optional
```python
web_acl_options: TypeSafeApiWebAclOptions
```
- *Type:* TypeSafeApiWebAclOptions
Options for the AWS WAF v2 WebACL associated with the api.
By default, a Web ACL with the AWS default managed
rule set will be associated with the API. These options may disable or override the defaults.
---
## Classes
### Authorizer
An authorizer for authorizing API requests.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizer(
authorization_type: AuthorizationType,
authorizer_id: str,
authorization_scopes: typing.List[str] = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
---
##### `authorization_type`Required
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
### Authorizers
Class used to construct authorizers for use in the OpenApiGatewayLambdaApi construct.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizers()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| cognito | A Cognito User Pools authorizer. |
| custom | A custom authorizer. |
| iam | An IAM authorizer which uses AWS signature version 4 to authorize requests. |
| none | No authorizer. |
---
##### `cognito`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizers.cognito(
authorizer_id: str,
user_pools: typing.List[IUserPool],
authorization_scopes: typing.List[str] = None
)
```
A Cognito User Pools authorizer.
###### `authorizer_id`Required
- *Type:* str
Unique identifier for this authorizer.
---
###### `user_pools`Required
- *Type:* typing.List[aws_cdk.aws_cognito.IUserPool]
The Cognito user pools associated with this authorizer.
---
###### `authorization_scopes`Optional
- *Type:* typing.List[str]
- *Default:* []
A list of authorization scopes configured on the method.
When used as the default authorizer, these scopes will be
applied to all methods without an authorizer at the integration level.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes)
---
##### `custom`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizers.custom(
authorizer_id: str,
function: IFunction,
authorizer_result_ttl_in_seconds: typing.Union[int, float] = None,
identity_source: str = None,
type: CustomAuthorizerType = None
)
```
A custom authorizer.
###### `authorizer_id`Required
- *Type:* str
Unique identifier for this authorizer.
---
###### `function`Required
- *Type:* aws_cdk.aws_lambda.IFunction
The lambda function used to authorize requests.
---
###### `authorizer_result_ttl_in_seconds`Optional
- *Type:* typing.Union[int, float]
- *Default:* 300
The number of seconds during which the authorizer result is cached.
---
###### `identity_source`Optional
- *Type:* str
- *Default:* "method.request.header.Authorization"
The source of the identity in an incoming request.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource)
---
###### `type`Optional
- *Type:* CustomAuthorizerType
- *Default:* CustomAuthorizerType.TOKEN
The type of custom authorizer.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type)
---
##### `iam`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizers.iam()
```
An IAM authorizer which uses AWS signature version 4 to authorize requests.
##### `none`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Authorizers.none()
```
No authorizer.
### CognitoAuthorizer
An authorizer that uses Cognito identity or access tokens.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CognitoAuthorizer(
authorizer_id: str,
user_pools: typing.List[IUserPool],
authorization_scopes: typing.List[str] = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorizer_id | str | Unique identifier for this authorizer. |
| user_pools | typing.List[aws_cdk.aws_cognito.IUserPool] | The Cognito user pools associated with this authorizer. |
| authorization_scopes | typing.List[str] | A list of authorization scopes configured on the method. |
---
##### `authorizer_id`Required
- *Type:* str
Unique identifier for this authorizer.
---
##### `user_pools`Required
- *Type:* typing.List[aws_cdk.aws_cognito.IUserPool]
The Cognito user pools associated with this authorizer.
---
##### `authorization_scopes`Optional
- *Type:* typing.List[str]
- *Default:* []
A list of authorization scopes configured on the method.
When used as the default authorizer, these scopes will be
applied to all methods without an authorizer at the integration level.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes)
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| with_scopes | Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis. |
---
##### `with_scopes`
```python
def with_scopes(
authorization_scopes: str
) -> CognitoAuthorizer
```
Returns this authorizer with scopes applied, intended for usage in individual operations where scopes may differ on a per-operation basis.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes)
###### `authorization_scopes`Required
- *Type:* str
the scopes to apply.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
| user_pools | typing.List[aws_cdk.aws_cognito.IUserPool] | The Cognito user pools associated with this authorizer. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
##### `user_pools`Required
```python
user_pools: typing.List[IUserPool]
```
- *Type:* typing.List[aws_cdk.aws_cognito.IUserPool]
The Cognito user pools associated with this authorizer.
---
### CustomAuthorizer
An authorizer that uses a lambda function to authorize requests.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.CustomAuthorizer(
authorizer_id: str,
function: IFunction,
authorizer_result_ttl_in_seconds: typing.Union[int, float] = None,
identity_source: str = None,
type: CustomAuthorizerType = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorizer_id | str | Unique identifier for this authorizer. |
| function | aws_cdk.aws_lambda.IFunction | The lambda function used to authorize requests. |
| authorizer_result_ttl_in_seconds | typing.Union[int, float] | The number of seconds during which the authorizer result is cached. |
| identity_source | str | The source of the identity in an incoming request. |
| type | CustomAuthorizerType | The type of custom authorizer. |
---
##### `authorizer_id`Required
- *Type:* str
Unique identifier for this authorizer.
---
##### `function`Required
- *Type:* aws_cdk.aws_lambda.IFunction
The lambda function used to authorize requests.
---
##### `authorizer_result_ttl_in_seconds`Optional
- *Type:* typing.Union[int, float]
- *Default:* 300
The number of seconds during which the authorizer result is cached.
---
##### `identity_source`Optional
- *Type:* str
- *Default:* "method.request.header.Authorization"
The source of the identity in an incoming request.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource)
---
##### `type`Optional
- *Type:* CustomAuthorizerType
- *Default:* CustomAuthorizerType.TOKEN
The type of custom authorizer.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
| authorizer_result_ttl_in_seconds | typing.Union[int, float] | The number of seconds during which the authorizer result is cached. |
| function | aws_cdk.aws_lambda.IFunction | The lambda function used to authorize requests. |
| identity_source | str | The source of the identity in an incoming request. |
| type | CustomAuthorizerType | The type of custom authorizer. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
##### `authorizer_result_ttl_in_seconds`Required
```python
authorizer_result_ttl_in_seconds: typing.Union[int, float]
```
- *Type:* typing.Union[int, float]
The number of seconds during which the authorizer result is cached.
---
##### `function`Required
```python
function: IFunction
```
- *Type:* aws_cdk.aws_lambda.IFunction
The lambda function used to authorize requests.
---
##### `identity_source`Required
```python
identity_source: str
```
- *Type:* str
The source of the identity in an incoming request.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource)
---
##### `type`Required
```python
type: CustomAuthorizerType
```
- *Type:* CustomAuthorizerType
The type of custom authorizer.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type)
---
### IamAuthorizer
An IAM authorizer.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.IamAuthorizer()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
### Integration
An integration for an API operation.
You can extend this to implement your own integration if you like.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Integration()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| grant | Grant permissions for the API to invoke the integration. |
| render | Render the integration into an API Gateway OpenAPI extension. |
---
##### `grant`
```python
def grant(
method: str,
path: str,
content_types: typing.List[str] = None,
api: SpecRestApi,
operation_id: str,
scope: Construct
) -> None
```
Grant permissions for the API to invoke the integration.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `api`Required
- *Type:* aws_cdk.aws_apigateway.SpecRestApi
The api to grant permissions for.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation for which permissions are being granted.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which permission resources can be created.
---
##### `render`
```python
def render(
method: str,
path: str,
content_types: typing.List[str] = None,
operation_id: str,
scope: Construct,
cors_options: SerializedCorsOptions = None
) -> ApiGatewayIntegration
```
Render the integration into an API Gateway OpenAPI extension.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation being rendered.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which the integration is being rendered.
---
###### `cors_options`Optional
- *Type:* SerializedCorsOptions
Cross Origin Resource Sharing options for the API.
---
### Integrations
A collection of integrations to connect API operations with a backend to service requests.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Integrations()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| lambda | An integration that invokes a lambda function to service the request. |
| mock | An integration that returns a hardcoded response. |
---
##### `lambda`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Integrations.lambda(
lambda_function: IFunction
)
```
An integration that invokes a lambda function to service the request.
###### `lambda_function`Required
- *Type:* aws_cdk.aws_lambda.IFunction
the function to invoke.
---
##### `mock`
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.Integrations.mock(
status_code: typing.Union[int, float],
body: str = None
)
```
An integration that returns a hardcoded response.
###### `status_code`Required
- *Type:* typing.Union[int, float]
HTTP response status code.
---
###### `body`Optional
- *Type:* str
Response body.
---
### LambdaIntegration
A lambda integration.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.LambdaIntegration(
lambda_function: IFunction
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| lambda_function | aws_cdk.aws_lambda.IFunction | *No description.* |
---
##### `lambda_function`Required
- *Type:* aws_cdk.aws_lambda.IFunction
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| grant | Grant API Gateway permissions to invoke the lambda. |
| render | Render the lambda integration as a snippet of OpenAPI. |
---
##### `grant`
```python
def grant(
method: str,
path: str,
content_types: typing.List[str] = None,
api: SpecRestApi,
operation_id: str,
scope: Construct
) -> None
```
Grant API Gateway permissions to invoke the lambda.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `api`Required
- *Type:* aws_cdk.aws_apigateway.SpecRestApi
The api to grant permissions for.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation for which permissions are being granted.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which permission resources can be created.
---
##### `render`
```python
def render(
method: str,
path: str,
content_types: typing.List[str] = None,
operation_id: str,
scope: Construct,
cors_options: SerializedCorsOptions = None
) -> ApiGatewayIntegration
```
Render the lambda integration as a snippet of OpenAPI.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation being rendered.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which the integration is being rendered.
---
###### `cors_options`Optional
- *Type:* SerializedCorsOptions
Cross Origin Resource Sharing options for the API.
---
### MockIntegration
A mock integration to return a hardcoded response.
> [https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration.html)
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.MockIntegration(
status_code: typing.Union[int, float],
body: str = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| status_code | typing.Union[int, float] | HTTP response status code. |
| body | str | Response body. |
---
##### `status_code`Required
- *Type:* typing.Union[int, float]
HTTP response status code.
---
##### `body`Optional
- *Type:* str
Response body.
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| grant | Grant permissions for the API to invoke the integration. |
| render | Render the integration into an API Gateway OpenAPI extension. |
---
##### `grant`
```python
def grant(
method: str,
path: str,
content_types: typing.List[str] = None,
api: SpecRestApi,
operation_id: str,
scope: Construct
) -> None
```
Grant permissions for the API to invoke the integration.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `api`Required
- *Type:* aws_cdk.aws_apigateway.SpecRestApi
The api to grant permissions for.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation for which permissions are being granted.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which permission resources can be created.
---
##### `render`
```python
def render(
method: str,
path: str,
content_types: typing.List[str] = None,
operation_id: str,
scope: Construct,
cors_options: SerializedCorsOptions = None
) -> ApiGatewayIntegration
```
Render the integration into an API Gateway OpenAPI extension.
###### `method`Required
- *Type:* str
The http method of this operation.
---
###### `path`Required
- *Type:* str
The path of this operation in the api.
---
###### `content_types`Optional
- *Type:* typing.List[str]
- *Default:* application/json
Content types accepted by this operation.
---
###### `operation_id`Required
- *Type:* str
The ID of the operation being rendered.
---
###### `scope`Required
- *Type:* constructs.Construct
The scope in which the integration is being rendered.
---
###### `cors_options`Optional
- *Type:* SerializedCorsOptions
Cross Origin Resource Sharing options for the API.
---
### NoneAuthorizer
No authorizer.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.NoneAuthorizer()
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| authorization_type | aws_cdk.aws_apigateway.AuthorizationType | The type of the authorizer. |
| authorizer_id | str | The unique identifier for the authorizer. |
| authorization_scopes | typing.List[str] | Scopes for the authorizer, if any. |
---
##### `authorization_type`Required
```python
authorization_type: AuthorizationType
```
- *Type:* aws_cdk.aws_apigateway.AuthorizationType
The type of the authorizer.
---
##### `authorizer_id`Required
```python
authorizer_id: str
```
- *Type:* str
The unique identifier for the authorizer.
---
##### `authorization_scopes`Optional
```python
authorization_scopes: typing.List[str]
```
- *Type:* typing.List[str]
Scopes for the authorizer, if any.
---
### OpenApiDefinition
The OpenAPI Spec.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.OpenApiDefinition(
project: TypeSafeApiModelProject,
open_api_options: OpenApiModelOptions,
handler_languages: typing.List[Language] = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| project | TypeSafeApiModelProject | *No description.* |
| open_api_options | OpenApiModelOptions | Options for the openapi model. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `project`Required
- *Type:* TypeSafeApiModelProject
---
##### `open_api_options`Required
- *Type:* OpenApiModelOptions
Options for the openapi model.
---
##### `handler_languages`Optional
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| post_synthesize | Called after synthesis. |
| pre_synthesize | Called before synthesis. |
| synthesize | Synthesizes files to the project output directory. |
---
##### `post_synthesize`
```python
def post_synthesize() -> None
```
Called after synthesis.
Order is *not* guaranteed.
##### `pre_synthesize`
```python
def pre_synthesize() -> None
```
Called before synthesis.
##### `synthesize`
```python
def synthesize() -> None
```
Synthesizes files to the project output directory.
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| project | projen.Project | *No description.* |
| open_api_specification_path | str | Path to the root OpenAPI specification file. |
---
##### `project`Required
```python
project: Project
```
- *Type:* projen.Project
---
##### `open_api_specification_path`Required
```python
open_api_specification_path: str
```
- *Type:* str
Path to the root OpenAPI specification file.
---
### SmithyDefinition
Creates a project which transforms a Smithy model to OpenAPI.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.SmithyDefinition(
project: TypeSafeApiModelProject,
smithy_options: SmithyModelOptions,
handler_languages: typing.List[Language] = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| project | TypeSafeApiModelProject | *No description.* |
| smithy_options | SmithyModelOptions | Smithy engine options. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `project`Required
- *Type:* TypeSafeApiModelProject
---
##### `smithy_options`Required
- *Type:* SmithyModelOptions
Smithy engine options.
---
##### `handler_languages`Optional
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| post_synthesize | Called after synthesis. |
| pre_synthesize | Called before synthesis. |
| synthesize | Synthesizes files to the project output directory. |
| add_deps | Add maven-style or local file dependencies to the smithy model project. |
| add_smithy_deps | Add dependencies on other smithy models, such that their shapes can be imported in this project. |
| add_sources | Add additional paths to model source files or directories. |
---
##### `post_synthesize`
```python
def post_synthesize() -> None
```
Called after synthesis.
Order is *not* guaranteed.
##### `pre_synthesize`
```python
def pre_synthesize() -> None
```
Called before synthesis.
##### `synthesize`
```python
def synthesize() -> None
```
Synthesizes files to the project output directory.
##### `add_deps`
```python
def add_deps(
deps: str
) -> None
```
Add maven-style or local file dependencies to the smithy model project.
###### `deps`Required
- *Type:* str
dependencies to add, eg "software.amazon.smithy:smithy-validation-model:1.27.2" or "file://../some/path/build/lib/my-shapes.jar.
---
##### `add_smithy_deps`
```python
def add_smithy_deps(
deps: SmithyDefinition
) -> None
```
Add dependencies on other smithy models, such that their shapes can be imported in this project.
###### `deps`Required
- *Type:* SmithyDefinition
smithy definitions to depend on.
---
##### `add_sources`
```python
def add_sources(
sources: str
) -> None
```
Add additional paths to model source files or directories.
Paths should be relative to the project outdir. Any absolute paths will be
resolved as relative paths.
###### `sources`Required
- *Type:* str
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| project | projen.Project | *No description.* |
| gradle_project_name | str | Name of the gradle project. |
| open_api_specification_path | str | Path to the generated OpenAPI specification, relative to the project outdir. |
| smithy_json_model_path | str | Path to the json Smithy model, relative to the project outdir. |
---
##### `project`Required
```python
project: Project
```
- *Type:* projen.Project
---
##### `gradle_project_name`Required
```python
gradle_project_name: str
```
- *Type:* str
Name of the gradle project.
---
##### `open_api_specification_path`Required
```python
open_api_specification_path: str
```
- *Type:* str
Path to the generated OpenAPI specification, relative to the project outdir.
---
##### `smithy_json_model_path`Required
```python
smithy_json_model_path: str
```
- *Type:* str
Path to the json Smithy model, relative to the project outdir.
---
### TypeSafeApiModelProject
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiModelProject(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
model_language: ModelLanguage,
model_options: ModelOptions,
handler_languages: typing.List[Language] = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| model_language | ModelLanguage | Language the model is defined in. |
| model_options | ModelOptions | Options for the model. |
| handler_languages | typing.List[Language] | The languages users have specified for handler projects (if any). |
---
##### `name`Required
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `model_language`Required
- *Type:* ModelLanguage
Language the model is defined in.
---
##### `model_options`Required
- *Type:* ModelOptions
Options for the model.
---
##### `handler_languages`Optional
- *Type:* typing.List[Language]
The languages users have specified for handler projects (if any).
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| add_exclude_from_cleanup | Exclude the matching files from pre-synth cleanup. |
| add_git_ignore | Adds a .gitignore pattern. |
| add_package_ignore | Exclude these files from the bundled package. |
| add_task | Adds a new task to this project. |
| add_tip | Prints a "tip" message during synthesis. |
| annotate_generated | Consider a set of files as "generated". |
| post_synthesize | Called after all components are synthesized. |
| pre_synthesize | Called before all components are synthesized. |
| remove_task | Removes a task from a project. |
| run_task_command | Returns the shell command to execute in order to run a task. |
| synth | Synthesize all project files into `outdir`. |
| try_find_file | Finds a file at the specified relative path within this project and all its subprojects. |
| try_find_json_file | Finds a json file by name. |
| try_find_object_file | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
| try_remove_file | Finds a file at the specified relative path within this project and removes it. |
---
##### `add_exclude_from_cleanup`
```python
def add_exclude_from_cleanup(
globs: str
) -> None
```
Exclude the matching files from pre-synth cleanup.
Can be used when, for example, some
source files include the projen marker and we don't want them to be erased during synth.
###### `globs`Required
- *Type:* str
The glob patterns to match.
---
##### `add_git_ignore`
```python
def add_git_ignore(
pattern: str
) -> None
```
Adds a .gitignore pattern.
###### `pattern`Required
- *Type:* str
The glob pattern to ignore.
---
##### `add_package_ignore`
```python
def add_package_ignore(
_pattern: str
) -> None
```
Exclude these files from the bundled package.
Implemented by project types based on the
packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
###### `_pattern`Required
- *Type:* str
The glob pattern to exclude.
---
##### `add_task`
```python
def add_task(
name: str,
condition: str = None,
cwd: str = None,
description: str = None,
env: typing.Mapping[str] = None,
required_env: typing.List[str] = None,
args: typing.List[str] = None,
exec: str = None,
receive_args: bool = None,
steps: typing.List[TaskStep] = None
) -> Task
```
Adds a new task to this project.
This will fail if the project already has
a task with this name.
###### `name`Required
- *Type:* str
The task name to add.
---
###### `condition`Optional
- *Type:* str
A shell command which determines if the this task should be executed.
If
the program exits with a zero exit code, steps will be executed. A non-zero
code means that task will be skipped.
---
###### `cwd`Optional
- *Type:* str
- *Default:* process.cwd()
The working directory for all steps in this task (unless overridden by the step).
---
###### `description`Optional
- *Type:* str
- *Default:* the task name
The description of this build command.
---
###### `env`Optional
- *Type:* typing.Mapping[str]
- *Default:* {}
Defines environment variables for the execution of this task.
Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`.
---
###### `required_env`Optional
- *Type:* typing.List[str]
A set of environment variables that must be defined in order to execute this task.
Task execution will fail if one of these is not defined.
---
###### `args`Optional
- *Type:* typing.List[str]
- *Default:* no arguments are passed to the step
Should the provided `exec` shell command receive fixed args.
> [{@link TaskStepOptions.args }]({@link TaskStepOptions.args })
---
###### `exec`Optional
- *Type:* str
- *Default:* add steps using `task.exec(command)` or `task.spawn(subtask)`
Shell command to execute as the first command of the task.
---
###### `receive_args`Optional
- *Type:* bool
- *Default:* false
Should the provided `exec` shell command receive args passed to the task.
> [{@link TaskStepOptions.receiveArgs }]({@link TaskStepOptions.receiveArgs })
---
###### `steps`Optional
- *Type:* typing.List[projen.TaskStep]
List of task steps to run.
---
##### ~~`add_tip`~~
```python
def add_tip(
message: str
) -> None
```
Prints a "tip" message during synthesis.
###### `message`Required
- *Type:* str
The message.
---
##### `annotate_generated`
```python
def annotate_generated(
_glob: str
) -> None
```
Consider a set of files as "generated".
This method is implemented by
derived classes and used for example, to add git attributes to tell GitHub
that certain files are generated.
###### `_glob`Required
- *Type:* str
the glob pattern to match (could be a file path).
---
##### `post_synthesize`
```python
def post_synthesize() -> None
```
Called after all components are synthesized.
Order is *not* guaranteed.
##### `pre_synthesize`
```python
def pre_synthesize() -> None
```
Called before all components are synthesized.
##### `remove_task`
```python
def remove_task(
name: str
) -> Task
```
Removes a task from a project.
###### `name`Required
- *Type:* str
The name of the task to remove.
---
##### `run_task_command`
```python
def run_task_command(
task: Task
) -> str
```
Returns the shell command to execute in order to run a task.
By default, this is `npx projen@ `
###### `task`Required
- *Type:* projen.Task
The task for which the command is required.
---
##### `synth`
```python
def synth() -> None
```
Synthesize all project files into `outdir`.
1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all sub-projects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. Call "this.postSynthesize()"
##### `try_find_file`
```python
def try_find_file(
file_path: str
) -> FileBase
```
Finds a file at the specified relative path within this project and all its subprojects.
###### `file_path`Required
- *Type:* str
The file path.
If this path is relative, it will be resolved
from the root of _this_ project.
---
##### ~~`try_find_json_file`~~
```python
def try_find_json_file(
file_path: str
) -> JsonFile
```
Finds a json file by name.
###### `file_path`Required
- *Type:* str
The file path.
---
##### `try_find_object_file`
```python
def try_find_object_file(
file_path: str
) -> ObjectFile
```
Finds an object file (like JsonFile, YamlFile, etc.) by name.
###### `file_path`Required
- *Type:* str
The file path.
---
##### `try_remove_file`
```python
def try_remove_file(
file_path: str
) -> FileBase
```
Finds a file at the specified relative path within this project and removes it.
###### `file_path`Required
- *Type:* str
The file path.
If this path is relative, it will be
resolved from the root of _this_ project.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| build_task | projen.Task | *No description.* |
| commit_generated | bool | Whether to commit the managed files by default. |
| compile_task | projen.Task | *No description.* |
| components | typing.List[projen.Component] | Returns all the components within this project. |
| deps | projen.Dependencies | Project dependencies. |
| ejected | bool | Whether or not the project is being ejected. |
| files | typing.List[projen.FileBase] | All files in this project. |
| gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. |
| gitignore | projen.IgnoreFile | .gitignore. |
| logger | projen.Logger | Logging utilities. |
| name | str | Project name. |
| outdir | str | Absolute output directory of this project. |
| package_task | projen.Task | *No description.* |
| post_compile_task | projen.Task | *No description.* |
| pre_compile_task | projen.Task | *No description.* |
| project_build | projen.ProjectBuild | Manages the build process of the project. |
| projen_command | str | The command to use in order to run the projen CLI. |
| root | projen.Project | The root project. |
| subprojects | typing.List[projen.Project] | Returns all the subprojects within this project. |
| tasks | projen.Tasks | Project tasks. |
| test_task | projen.Task | *No description.* |
| default_task | projen.Task | This is the "default" task, the one that executes "projen". |
| init_project | projen.InitProject | The options used when this project is bootstrapped via `projen new`. |
| parent | projen.Project | A parent project. |
| generate_task | projen.Task | Reference to the task used for generating the final bundled OpenAPI specification. |
| parsed_spec_file | str | Name of the final bundled OpenAPI specification. |
| openapi | OpenApiDefinition | Reference to the OpenAPI definition component. |
| smithy | SmithyDefinition | Reference to the Smithy definition component. |
---
##### `build_task`Required
```python
build_task: Task
```
- *Type:* projen.Task
---
##### `commit_generated`Required
```python
commit_generated: bool
```
- *Type:* bool
Whether to commit the managed files by default.
---
##### `compile_task`Required
```python
compile_task: Task
```
- *Type:* projen.Task
---
##### `components`Required
```python
components: typing.List[Component]
```
- *Type:* typing.List[projen.Component]
Returns all the components within this project.
---
##### `deps`Required
```python
deps: Dependencies
```
- *Type:* projen.Dependencies
Project dependencies.
---
##### `ejected`Required
```python
ejected: bool
```
- *Type:* bool
Whether or not the project is being ejected.
---
##### `files`Required
```python
files: typing.List[FileBase]
```
- *Type:* typing.List[projen.FileBase]
All files in this project.
---
##### `gitattributes`Required
```python
gitattributes: GitAttributesFile
```
- *Type:* projen.GitAttributesFile
The .gitattributes file for this repository.
---
##### `gitignore`Required
```python
gitignore: IgnoreFile
```
- *Type:* projen.IgnoreFile
.gitignore.
---
##### `logger`Required
```python
logger: Logger
```
- *Type:* projen.Logger
Logging utilities.
---
##### `name`Required
```python
name: str
```
- *Type:* str
Project name.
---
##### `outdir`Required
```python
outdir: str
```
- *Type:* str
Absolute output directory of this project.
---
##### `package_task`Required
```python
package_task: Task
```
- *Type:* projen.Task
---
##### `post_compile_task`Required
```python
post_compile_task: Task
```
- *Type:* projen.Task
---
##### `pre_compile_task`Required
```python
pre_compile_task: Task
```
- *Type:* projen.Task
---
##### `project_build`Required
```python
project_build: ProjectBuild
```
- *Type:* projen.ProjectBuild
Manages the build process of the project.
---
##### `projen_command`Required
```python
projen_command: str
```
- *Type:* str
The command to use in order to run the projen CLI.
---
##### `root`Required
```python
root: Project
```
- *Type:* projen.Project
The root project.
---
##### `subprojects`Required
```python
subprojects: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Returns all the subprojects within this project.
---
##### `tasks`Required
```python
tasks: Tasks
```
- *Type:* projen.Tasks
Project tasks.
---
##### `test_task`Required
```python
test_task: Task
```
- *Type:* projen.Task
---
##### `default_task`Optional
```python
default_task: Task
```
- *Type:* projen.Task
This is the "default" task, the one that executes "projen".
Undefined if
the project is being ejected.
---
##### `init_project`Optional
```python
init_project: InitProject
```
- *Type:* projen.InitProject
The options used when this project is bootstrapped via `projen new`.
It
includes the original set of options passed to the CLI and also the JSII
FQN of the project type.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
A parent project.
If undefined, this is the root project.
---
##### `generate_task`Required
```python
generate_task: Task
```
- *Type:* projen.Task
Reference to the task used for generating the final bundled OpenAPI specification.
---
##### `parsed_spec_file`Required
```python
parsed_spec_file: str
```
- *Type:* str
Name of the final bundled OpenAPI specification.
---
##### `openapi`Optional
```python
openapi: OpenApiDefinition
```
- *Type:* OpenApiDefinition
Reference to the OpenAPI definition component.
Will be defined if the model language is OpenAPI
---
##### `smithy`Optional
```python
smithy: SmithyDefinition
```
- *Type:* SmithyDefinition
Reference to the Smithy definition component.
Will be defined if the model language is Smithy
---
#### Constants
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DEFAULT_TASK | str | The name of the default task (the task executed when `projen` is run without arguments). |
---
##### `DEFAULT_TASK`Required
```python
DEFAULT_TASK: str
```
- *Type:* str
The name of the default task (the task executed when `projen` is run without arguments).
Normally
this task should synthesize the project files.
---
### TypeSafeApiProject
Project for a type-safe API, defined using Smithy or OpenAPI.
Generates a CDK construct to deploy your API, as well as client and server code to help build your API quickly.
#### Initializers
```python
import aws_prototyping_sdk.type_safe_api
aws_prototyping_sdk.type_safe_api.TypeSafeApiProject(
name: str,
commit_generated: bool = None,
git_ignore_options: IgnoreFileOptions = None,
git_options: GitOptions = None,
logging: LoggerOptions = None,
outdir: str = None,
parent: Project = None,
projen_command: str = None,
projenrc_json: bool = None,
projenrc_json_options: ProjenrcJsonOptions = None,
renovatebot: bool = None,
renovatebot_options: RenovatebotOptions = None,
infrastructure: InfrastructureConfiguration,
model: ModelConfiguration,
runtime: RuntimeConfiguration,
documentation: DocumentationConfiguration = None,
handlers: HandlersConfiguration = None,
library: LibraryConfiguration = None
)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | str | This is the name of your project. |
| commit_generated | bool | Whether to commit the managed files by default. |
| git_ignore_options | projen.IgnoreFileOptions | Configuration options for .gitignore file. |
| git_options | projen.GitOptions | Configuration options for git. |
| logging | projen.LoggerOptions | Configure logging options such as verbosity. |
| outdir | str | The root directory of the project. |
| parent | projen.Project | The parent project, if this project is part of a bigger project. |
| projen_command | str | The shell command to use in order to run the projen CLI. |
| projenrc_json | bool | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
| projenrc_json_options | projen.ProjenrcJsonOptions | Options for .projenrc.json. |
| renovatebot | bool | Use renovatebot to handle dependency upgrades. |
| renovatebot_options | projen.RenovatebotOptions | Options for renovatebot. |
| infrastructure | InfrastructureConfiguration | Configuration for generated infrastructure. |
| model | ModelConfiguration | Configuration for the API model. |
| runtime | RuntimeConfiguration | Configuration for generated runtime projects (containing types, clients and server code). |
| documentation | DocumentationConfiguration | Configuration for generated documentation. |
| handlers | HandlersConfiguration | Configuration for lambda handlers for implementing the API. |
| library | LibraryConfiguration | Configuration for generated libraries. |
---
##### `name`Required
- *Type:* str
- *Default:* $BASEDIR
This is the name of your project.
---
##### `commit_generated`Optional
- *Type:* bool
- *Default:* true
Whether to commit the managed files by default.
---
##### `git_ignore_options`Optional
- *Type:* projen.IgnoreFileOptions
Configuration options for .gitignore file.
---
##### `git_options`Optional
- *Type:* projen.GitOptions
Configuration options for git.
---
##### `logging`Optional
- *Type:* projen.LoggerOptions
- *Default:* {}
Configure logging options such as verbosity.
---
##### `outdir`Optional
- *Type:* str
- *Default:* "."
The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent
directory and it cannot be the same as the parent or any of it's other
sub-projects.
---
##### `parent`Optional
- *Type:* projen.Project
The parent project, if this project is part of a bigger project.
---
##### `projen_command`Optional
- *Type:* str
- *Default:* "npx projen"
The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.
---
##### `projenrc_json`Optional
- *Type:* bool
- *Default:* false
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
---
##### `projenrc_json_options`Optional
- *Type:* projen.ProjenrcJsonOptions
- *Default:* default options
Options for .projenrc.json.
---
##### `renovatebot`Optional
- *Type:* bool
- *Default:* false
Use renovatebot to handle dependency upgrades.
---
##### `renovatebot_options`Optional
- *Type:* projen.RenovatebotOptions
- *Default:* default options
Options for renovatebot.
---
##### `infrastructure`Required
- *Type:* InfrastructureConfiguration
Configuration for generated infrastructure.
---
##### `model`Required
- *Type:* ModelConfiguration
Configuration for the API model.
---
##### `runtime`Required
- *Type:* RuntimeConfiguration
Configuration for generated runtime projects (containing types, clients and server code).
---
##### `documentation`Optional
- *Type:* DocumentationConfiguration
Configuration for generated documentation.
---
##### `handlers`Optional
- *Type:* HandlersConfiguration
Configuration for lambda handlers for implementing the API.
---
##### `library`Optional
- *Type:* LibraryConfiguration
Configuration for generated libraries.
Libraries are projects which are generated from your model, but are not
fully-fledged runtimes, for example react hooks or clients in languages that aren't supported as runtimes.
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| add_exclude_from_cleanup | Exclude the matching files from pre-synth cleanup. |
| add_git_ignore | Adds a .gitignore pattern. |
| add_package_ignore | Exclude these files from the bundled package. |
| add_task | Adds a new task to this project. |
| add_tip | Prints a "tip" message during synthesis. |
| annotate_generated | Consider a set of files as "generated". |
| post_synthesize | Called after all components are synthesized. |
| pre_synthesize | Called before all components are synthesized. |
| remove_task | Removes a task from a project. |
| run_task_command | Returns the shell command to execute in order to run a task. |
| synth | Synthesize all project files into `outdir`. |
| try_find_file | Finds a file at the specified relative path within this project and all its subprojects. |
| try_find_json_file | Finds a json file by name. |
| try_find_object_file | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
| try_remove_file | Finds a file at the specified relative path within this project and removes it. |
---
##### `add_exclude_from_cleanup`
```python
def add_exclude_from_cleanup(
globs: str
) -> None
```
Exclude the matching files from pre-synth cleanup.
Can be used when, for example, some
source files include the projen marker and we don't want them to be erased during synth.
###### `globs`Required
- *Type:* str
The glob patterns to match.
---
##### `add_git_ignore`
```python
def add_git_ignore(
pattern: str
) -> None
```
Adds a .gitignore pattern.
###### `pattern`Required
- *Type:* str
The glob pattern to ignore.
---
##### `add_package_ignore`
```python
def add_package_ignore(
_pattern: str
) -> None
```
Exclude these files from the bundled package.
Implemented by project types based on the
packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
###### `_pattern`Required
- *Type:* str
The glob pattern to exclude.
---
##### `add_task`
```python
def add_task(
name: str,
condition: str = None,
cwd: str = None,
description: str = None,
env: typing.Mapping[str] = None,
required_env: typing.List[str] = None,
args: typing.List[str] = None,
exec: str = None,
receive_args: bool = None,
steps: typing.List[TaskStep] = None
) -> Task
```
Adds a new task to this project.
This will fail if the project already has
a task with this name.
###### `name`Required
- *Type:* str
The task name to add.
---
###### `condition`Optional
- *Type:* str
A shell command which determines if the this task should be executed.
If
the program exits with a zero exit code, steps will be executed. A non-zero
code means that task will be skipped.
---
###### `cwd`Optional
- *Type:* str
- *Default:* process.cwd()
The working directory for all steps in this task (unless overridden by the step).
---
###### `description`Optional
- *Type:* str
- *Default:* the task name
The description of this build command.
---
###### `env`Optional
- *Type:* typing.Mapping[str]
- *Default:* {}
Defines environment variables for the execution of this task.
Values in this map will be evaluated in a shell, so you can do stuff like `$(echo "foo")`.
---
###### `required_env`Optional
- *Type:* typing.List[str]
A set of environment variables that must be defined in order to execute this task.
Task execution will fail if one of these is not defined.
---
###### `args`Optional
- *Type:* typing.List[str]
- *Default:* no arguments are passed to the step
Should the provided `exec` shell command receive fixed args.
> [{@link TaskStepOptions.args }]({@link TaskStepOptions.args })
---
###### `exec`Optional
- *Type:* str
- *Default:* add steps using `task.exec(command)` or `task.spawn(subtask)`
Shell command to execute as the first command of the task.
---
###### `receive_args`Optional
- *Type:* bool
- *Default:* false
Should the provided `exec` shell command receive args passed to the task.
> [{@link TaskStepOptions.receiveArgs }]({@link TaskStepOptions.receiveArgs })
---
###### `steps`Optional
- *Type:* typing.List[projen.TaskStep]
List of task steps to run.
---
##### ~~`add_tip`~~
```python
def add_tip(
message: str
) -> None
```
Prints a "tip" message during synthesis.
###### `message`Required
- *Type:* str
The message.
---
##### `annotate_generated`
```python
def annotate_generated(
_glob: str
) -> None
```
Consider a set of files as "generated".
This method is implemented by
derived classes and used for example, to add git attributes to tell GitHub
that certain files are generated.
###### `_glob`Required
- *Type:* str
the glob pattern to match (could be a file path).
---
##### `post_synthesize`
```python
def post_synthesize() -> None
```
Called after all components are synthesized.
Order is *not* guaranteed.
##### `pre_synthesize`
```python
def pre_synthesize() -> None
```
Called before all components are synthesized.
##### `remove_task`
```python
def remove_task(
name: str
) -> Task
```
Removes a task from a project.
###### `name`Required
- *Type:* str
The name of the task to remove.
---
##### `run_task_command`
```python
def run_task_command(
task: Task
) -> str
```
Returns the shell command to execute in order to run a task.
By default, this is `npx projen@ `
###### `task`Required
- *Type:* projen.Task
The task for which the command is required.
---
##### `synth`
```python
def synth() -> None
```
Synthesize all project files into `outdir`.
1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all sub-projects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. Call "this.postSynthesize()"
##### `try_find_file`
```python
def try_find_file(
file_path: str
) -> FileBase
```
Finds a file at the specified relative path within this project and all its subprojects.
###### `file_path`Required
- *Type:* str
The file path.
If this path is relative, it will be resolved
from the root of _this_ project.
---
##### ~~`try_find_json_file`~~
```python
def try_find_json_file(
file_path: str
) -> JsonFile
```
Finds a json file by name.
###### `file_path`Required
- *Type:* str
The file path.
---
##### `try_find_object_file`
```python
def try_find_object_file(
file_path: str
) -> ObjectFile
```
Finds an object file (like JsonFile, YamlFile, etc.) by name.
###### `file_path`Required
- *Type:* str
The file path.
---
##### `try_remove_file`
```python
def try_remove_file(
file_path: str
) -> FileBase
```
Finds a file at the specified relative path within this project and removes it.
###### `file_path`Required
- *Type:* str
The file path.
If this path is relative, it will be
resolved from the root of _this_ project.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| build_task | projen.Task | *No description.* |
| commit_generated | bool | Whether to commit the managed files by default. |
| compile_task | projen.Task | *No description.* |
| components | typing.List[projen.Component] | Returns all the components within this project. |
| deps | projen.Dependencies | Project dependencies. |
| ejected | bool | Whether or not the project is being ejected. |
| files | typing.List[projen.FileBase] | All files in this project. |
| gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. |
| gitignore | projen.IgnoreFile | .gitignore. |
| logger | projen.Logger | Logging utilities. |
| name | str | Project name. |
| outdir | str | Absolute output directory of this project. |
| package_task | projen.Task | *No description.* |
| post_compile_task | projen.Task | *No description.* |
| pre_compile_task | projen.Task | *No description.* |
| project_build | projen.ProjectBuild | Manages the build process of the project. |
| projen_command | str | The command to use in order to run the projen CLI. |
| root | projen.Project | The root project. |
| subprojects | typing.List[projen.Project] | Returns all the subprojects within this project. |
| tasks | projen.Tasks | Project tasks. |
| test_task | projen.Task | *No description.* |
| default_task | projen.Task | This is the "default" task, the one that executes "projen". |
| init_project | projen.InitProject | The options used when this project is bootstrapped via `projen new`. |
| parent | projen.Project | A parent project. |
| all | ProjectCollections | Collections of all sub-projects managed by this project. |
| documentation | GeneratedDocumentationProjects | Generated documentation projects. |
| handlers | GeneratedCodeProjects | Lambda handlers projects. |
| infrastructure | GeneratedCodeProjects | Generated infrastructure projects. |
| library | GeneratedLibraryProjects | Generated library projects. |
| model | TypeSafeApiModelProject | Project for the api model. |
| runtime | GeneratedCodeProjects | Generated runtime projects. |
---
##### `build_task`Required
```python
build_task: Task
```
- *Type:* projen.Task
---
##### `commit_generated`Required
```python
commit_generated: bool
```
- *Type:* bool
Whether to commit the managed files by default.
---
##### `compile_task`Required
```python
compile_task: Task
```
- *Type:* projen.Task
---
##### `components`Required
```python
components: typing.List[Component]
```
- *Type:* typing.List[projen.Component]
Returns all the components within this project.
---
##### `deps`Required
```python
deps: Dependencies
```
- *Type:* projen.Dependencies
Project dependencies.
---
##### `ejected`Required
```python
ejected: bool
```
- *Type:* bool
Whether or not the project is being ejected.
---
##### `files`Required
```python
files: typing.List[FileBase]
```
- *Type:* typing.List[projen.FileBase]
All files in this project.
---
##### `gitattributes`Required
```python
gitattributes: GitAttributesFile
```
- *Type:* projen.GitAttributesFile
The .gitattributes file for this repository.
---
##### `gitignore`Required
```python
gitignore: IgnoreFile
```
- *Type:* projen.IgnoreFile
.gitignore.
---
##### `logger`Required
```python
logger: Logger
```
- *Type:* projen.Logger
Logging utilities.
---
##### `name`Required
```python
name: str
```
- *Type:* str
Project name.
---
##### `outdir`Required
```python
outdir: str
```
- *Type:* str
Absolute output directory of this project.
---
##### `package_task`Required
```python
package_task: Task
```
- *Type:* projen.Task
---
##### `post_compile_task`Required
```python
post_compile_task: Task
```
- *Type:* projen.Task
---
##### `pre_compile_task`Required
```python
pre_compile_task: Task
```
- *Type:* projen.Task
---
##### `project_build`Required
```python
project_build: ProjectBuild
```
- *Type:* projen.ProjectBuild
Manages the build process of the project.
---
##### `projen_command`Required
```python
projen_command: str
```
- *Type:* str
The command to use in order to run the projen CLI.
---
##### `root`Required
```python
root: Project
```
- *Type:* projen.Project
The root project.
---
##### `subprojects`Required
```python
subprojects: typing.List[Project]
```
- *Type:* typing.List[projen.Project]
Returns all the subprojects within this project.
---
##### `tasks`Required
```python
tasks: Tasks
```
- *Type:* projen.Tasks
Project tasks.
---
##### `test_task`Required
```python
test_task: Task
```
- *Type:* projen.Task
---
##### `default_task`Optional
```python
default_task: Task
```
- *Type:* projen.Task
This is the "default" task, the one that executes "projen".
Undefined if
the project is being ejected.
---
##### `init_project`Optional
```python
init_project: InitProject
```
- *Type:* projen.InitProject
The options used when this project is bootstrapped via `projen new`.
It
includes the original set of options passed to the CLI and also the JSII
FQN of the project type.
---
##### `parent`Optional
```python
parent: Project
```
- *Type:* projen.Project
A parent project.
If undefined, this is the root project.
---
##### `all`Required
```python
all: ProjectCollections
```
- *Type:* ProjectCollections
Collections of all sub-projects managed by this project.
---
##### `documentation`Required
```python
documentation: GeneratedDocumentationProjects
```
- *Type:* GeneratedDocumentationProjects
Generated documentation projects.
Only the properties corresponding to specified `documentation.formats` will be defined.
---
##### `handlers`Required
```python
handlers: GeneratedCodeProjects
```
- *Type:* GeneratedCodeProjects
Lambda handlers projects.
Only the properties corresponding to `handlers.languages` will be defined.
---
##### `infrastructure`Required
```python
infrastructure: GeneratedCodeProjects
```
- *Type:* GeneratedCodeProjects
Generated infrastructure projects.
Only the property corresponding to `infrastructure.language` will be defined.
---
##### `library`Required
```python
library: GeneratedLibraryProjects
```
- *Type:* GeneratedLibraryProjects
Generated library projects.
Only the properties corresponding to specified `library.libraries` will be defined.
---
##### `model`Required
```python
model: TypeSafeApiModelProject
```
- *Type:* TypeSafeApiModelProject
Project for the api model.
---
##### `runtime`Required
```python
runtime: GeneratedCodeProjects
```
- *Type:* GeneratedCodeProjects
Generated runtime projects.
When `runtime.languages` includes the corresponding language, the project can be
assumed to be defined.
---
#### Constants
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DEFAULT_TASK | str | The name of the default task (the task executed when `projen` is run without arguments). |
---
##### `DEFAULT_TASK`Required
```python
DEFAULT_TASK: str
```
- *Type:* str
The name of the default task (the task executed when `projen` is run without arguments).
Normally
this task should synthesize the project files.
---
## Enums
### CustomAuthorizerType
The type of custom authorizer.
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type)
#### Members
| **Name** | **Description** |
| --- | --- |
| TOKEN | A custom authorizer that uses a Lambda function. |
| REQUEST | An authorizer that uses a Lambda function using incoming request parameters. |
---
##### `TOKEN`
A custom authorizer that uses a Lambda function.
---
##### `REQUEST`
An authorizer that uses a Lambda function using incoming request parameters.
---
### DocumentationFormat
Formats for documentation generation.
#### Members
| **Name** | **Description** |
| --- | --- |
| HTML_REDOC | HTML Documentation generated by redoc. |
| HTML2 | OpenAPI Generator 'html2' documentation. |
| MARKDOWN | OpenAPI Generator 'markdown' documentation. |
| PLANTUML | OpenAPI Generator 'plantuml' documentation. |
---
##### `HTML_REDOC`
HTML Documentation generated by redoc.
> [https://github.com/Redocly/redoc](https://github.com/Redocly/redoc)
---
##### `HTML2`
OpenAPI Generator 'html2' documentation.
> [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md)
---
##### `MARKDOWN`
OpenAPI Generator 'markdown' documentation.
> [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/markdown.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/markdown.md)
---
##### `PLANTUML`
OpenAPI Generator 'plantuml' documentation.
> [https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/plantuml.md](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/plantuml.md)
---
### Language
Supported languages for runtimes and infrastructure.
#### Members
| **Name** | **Description** |
| --- | --- |
| TYPESCRIPT | *No description.* |
| PYTHON | *No description.* |
| JAVA | *No description.* |
---
##### `TYPESCRIPT`
---
##### `PYTHON`
---
##### `JAVA`
---
### Library
Supported libraries for code generation.
#### Members
| **Name** | **Description** |
| --- | --- |
| TYPESCRIPT_REACT_QUERY_HOOKS | *No description.* |
---
##### `TYPESCRIPT_REACT_QUERY_HOOKS`
---
### ModelLanguage
The model definition language.
#### Members
| **Name** | **Description** |
| --- | --- |
| SMITHY | Smithy. |
| OPENAPI | OpenAPI. |
---
##### `SMITHY`
Smithy.
> [https://smithy.io/2.0/](https://smithy.io/2.0/)
---
##### `OPENAPI`
OpenAPI.
> [https://www.openapis.org/](https://www.openapis.org/)
---