CfnApiKeyProps

class aws_cdk.aws_appsync.CfnApiKeyProps(*, api_id, api_key_id=None, description=None, expires=None)

Bases: object

Properties for defining a CfnApiKey.

Parameters
  • api_id (str) – Unique AWS AppSync GraphQL API ID for this API key.

  • api_key_id (Optional[str]) – The API key ID.

  • description (Optional[str]) – Unique description of your API key.

  • expires (Union[int, float, None]) – The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appsync as appsync

cfn_api_key_props = appsync.CfnApiKeyProps(
    api_id="apiId",

    # the properties below are optional
    api_key_id="apiKeyId",
    description="description",
    expires=123
)

Attributes

api_id

Unique AWS AppSync GraphQL API ID for this API key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apiid

Return type

str

api_key_id

The API key ID.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-apikeyid

Return type

Optional[str]

description

Unique description of your API key.

Link

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

Return type

Optional[str]

expires

The time after which the API key expires.

The date is represented as seconds since the epoch, rounded down to the nearest hour.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-apikey.html#cfn-appsync-apikey-expires

Return type

Union[int, float, None]