AddApiKeyOptions

class aws_cdk.aws_apigateway.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

Example:

# usageplan is of type UsagePlan
# api_key is of type ApiKey


usageplan.add_api_key(api_key,
    override_logical_id="..."
)

Attributes

override_logical_id

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

Default
  • autogenerated by the CDK

Return type

Optional[str]