EventApiAuthConfig

class aws_cdk.aws_appsync.EventApiAuthConfig(*, auth_providers=None, connection_auth_mode_types=None, default_publish_auth_mode_types=None, default_subscribe_auth_mode_types=None)

Bases: object

Authorization configuration for the Event API.

Parameters:
  • auth_providers (Optional[Sequence[Union[AppSyncAuthProvider, Dict[str, Any]]]]) – Auth providers for use in connection, publish, and subscribe operations. Default: - API Key authorization

  • connection_auth_mode_types (Optional[Sequence[AppSyncAuthorizationType]]) – Connection auth modes. Default: - API Key authorization

  • default_publish_auth_mode_types (Optional[Sequence[AppSyncAuthorizationType]]) – Default publish auth modes. Default: - API Key authorization

  • default_subscribe_auth_mode_types (Optional[Sequence[AppSyncAuthorizationType]]) – Default subscribe auth modes. Default: - API Key authorization

ExampleMetadata:

infused

Example:

import aws_cdk.aws_logs as logs


api_key_provider = appsync.AppSyncAuthProvider(
    authorization_type=appsync.AppSyncAuthorizationType.API_KEY
)

api = appsync.EventApi(self, "api",
    api_name="Api",
    owner_contact="OwnerContact",
    authorization_config=appsync.EventApiAuthConfig(
        auth_providers=[api_key_provider
        ],
        connection_auth_mode_types=[appsync.AppSyncAuthorizationType.API_KEY
        ],
        default_publish_auth_mode_types=[appsync.AppSyncAuthorizationType.API_KEY
        ],
        default_subscribe_auth_mode_types=[appsync.AppSyncAuthorizationType.API_KEY
        ]
    ),
    log_config=appsync.AppSyncLogConfig(
        field_log_level=appsync.AppSyncFieldLogLevel.INFO,
        retention=logs.RetentionDays.ONE_WEEK
    )
)

api.add_channel_namespace("default")

Attributes

auth_providers

Auth providers for use in connection, publish, and subscribe operations.

Default:
  • API Key authorization

connection_auth_mode_types

Connection auth modes.

Default:
  • API Key authorization

default_publish_auth_mode_types

Default publish auth modes.

Default:
  • API Key authorization

default_subscribe_auth_mode_types

Default subscribe auth modes.

Default:
  • API Key authorization