AddApiKeyOptions

class aws_cdk.aws_apigatewayv2.AddApiKeyOptions(*, override_logical_id=None)

Bases: object

Options to the UsagePlan.addApiKey() method.

Parameters:: override_logical_id (Optional[str]) – Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource. Default: - autogenerated by the CDK
ExampleMetadata:: infused

Example:

# usage_plan: apigwv2.UsagePlan
# api_key: apigwv2.ApiKey


usage_plan.add_api_key(api_key,
    override_logical_id="MyCustomLogicalId"
)

Attributes

override_logical_id

Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

Default: