CfnApiKeyProps

class aws_cdk.aws_apigateway.CfnApiKeyProps(*, customer_id=None, description=None, enabled=None, generate_distinct_id=None, name=None, stage_keys=None, tags=None, value=None)

Bases: object

__init__(*, customer_id=None, description=None, enabled=None, generate_distinct_id=None, name=None, stage_keys=None, tags=None, value=None)

Properties for defining a AWS::ApiGateway::ApiKey.

Parameters
  • customer_id (Optional[str]) – AWS::ApiGateway::ApiKey.CustomerId.

  • description (Optional[str]) – AWS::ApiGateway::ApiKey.Description.

  • enabled (Union[bool, None, IResolvable]) – AWS::ApiGateway::ApiKey.Enabled.

  • generate_distinct_id (Union[bool, None, IResolvable]) – AWS::ApiGateway::ApiKey.GenerateDistinctId.

  • name (Optional[str]) – AWS::ApiGateway::ApiKey.Name.

  • stage_keys (Union[IResolvable, None, List[Union[IResolvable, StageKeyProperty]]]) – AWS::ApiGateway::ApiKey.StageKeys.

  • tags (Optional[List[CfnTag]]) – AWS::ApiGateway::ApiKey.Tags.

  • value (Optional[str]) – AWS::ApiGateway::ApiKey.Value.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html

Attributes

customer_id

AWS::ApiGateway::ApiKey.CustomerId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

Return type

Optional[str]

description

AWS::ApiGateway::ApiKey.Description.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

Return type

Optional[str]

enabled

AWS::ApiGateway::ApiKey.Enabled.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

Return type

Union[bool, None, IResolvable]

generate_distinct_id

AWS::ApiGateway::ApiKey.GenerateDistinctId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

Return type

Union[bool, None, IResolvable]

name

AWS::ApiGateway::ApiKey.Name.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

Return type

Optional[str]

stage_keys

AWS::ApiGateway::ApiKey.StageKeys.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

Return type

Union[IResolvable, None, List[Union[IResolvable, StageKeyProperty]]]

tags

AWS::ApiGateway::ApiKey.Tags.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags

Return type

Optional[List[CfnTag]]

value

AWS::ApiGateway::ApiKey.Value.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

Return type

Optional[str]