CfnApiMixinProps

class aws_cdk.mixins_preview.aws_appsync.mixins.CfnApiMixinProps(*, event_config=None, name=None, owner_contact=None, tags=None)

Bases: object

Properties for CfnApiPropsMixin.

Parameters:

event_config (Union[IResolvable, EventConfigProperty, Dict[str, Any], None]) – Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
name (Optional[str]) – The name of the Api .
owner_contact (Optional[str]) – The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A set of tags (key-value pairs) for this API.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_api_mixin_props = appsync_mixins.CfnApiMixinProps(
    event_config=appsync_mixins.CfnApiPropsMixin.EventConfigProperty(
        auth_providers=[appsync_mixins.CfnApiPropsMixin.AuthProviderProperty(
            auth_type="authType",
            cognito_config=appsync_mixins.CfnApiPropsMixin.CognitoConfigProperty(
                app_id_client_regex="appIdClientRegex",
                aws_region="awsRegion",
                user_pool_id="userPoolId"
            ),
            lambda_authorizer_config=appsync_mixins.CfnApiPropsMixin.LambdaAuthorizerConfigProperty(
                authorizer_result_ttl_in_seconds=123,
                authorizer_uri="authorizerUri",
                identity_validation_expression="identityValidationExpression"
            ),
            open_id_connect_config=appsync_mixins.CfnApiPropsMixin.OpenIDConnectConfigProperty(
                auth_ttl=123,
                client_id="clientId",
                iat_ttl=123,
                issuer="issuer"
            )
        )],
        connection_auth_modes=[appsync_mixins.CfnApiPropsMixin.AuthModeProperty(
            auth_type="authType"
        )],
        default_publish_auth_modes=[appsync_mixins.CfnApiPropsMixin.AuthModeProperty(
            auth_type="authType"
        )],
        default_subscribe_auth_modes=[appsync_mixins.CfnApiPropsMixin.AuthModeProperty(
            auth_type="authType"
        )],
        log_config=appsync_mixins.CfnApiPropsMixin.EventLogConfigProperty(
            cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
            log_level="logLevel"
        )
    ),
    name="name",
    owner_contact="ownerContact",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

event_config

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-eventconfig

name

The name of the Api .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-name

owner_contact

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-ownercontact

tags

A set of tags (key-value pairs) for this API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-api.html#cfn-appsync-api-tags