CfnApi

class aws_cdk.aws_appsync.CfnApi(scope, id, *, name, event_config=None, owner_contact=None, tags=None)

Bases: CfnResource

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

See:

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

CloudformationResource:

AWS::AppSync::Api

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 import aws_appsync as appsync

cfn_api = appsync.CfnApi(self, "MyCfnApi",
    name="name",

    # the properties below are optional
    event_config=appsync.CfnApi.EventConfigProperty(
        auth_providers=[appsync.CfnApi.AuthProviderProperty(
            auth_type="authType",

            # the properties below are optional
            cognito_config=appsync.CfnApi.CognitoConfigProperty(
                aws_region="awsRegion",
                user_pool_id="userPoolId",

                # the properties below are optional
                app_id_client_regex="appIdClientRegex"
            ),
            lambda_authorizer_config=appsync.CfnApi.LambdaAuthorizerConfigProperty(
                authorizer_uri="authorizerUri",

                # the properties below are optional
                authorizer_result_ttl_in_seconds=123,
                identity_validation_expression="identityValidationExpression"
            ),
            open_id_connect_config=appsync.CfnApi.OpenIDConnectConfigProperty(
                issuer="issuer",

                # the properties below are optional
                auth_ttl=123,
                client_id="clientId",
                iat_ttl=123
            )
        )],
        connection_auth_modes=[appsync.CfnApi.AuthModeProperty(
            auth_type="authType"
        )],
        default_publish_auth_modes=[appsync.CfnApi.AuthModeProperty(
            auth_type="authType"
        )],
        default_subscribe_auth_modes=[appsync.CfnApi.AuthModeProperty(
            auth_type="authType"
        )],

        # the properties below are optional
        log_config=appsync.CfnApi.EventLogConfigProperty(
            cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
            log_level="logLevel"
        )
    ),
    owner_contact="ownerContact",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • name (str) – The name of the Api .

  • 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.

  • 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AppSync::Api'
attr_api_arn

The Amazon Resource Name (ARN) of the AWS AppSync Api.

CloudformationAttribute:

ApiArn

attr_api_id

The unique identifier for the AWS AppSync Api generated by the service.

CloudformationAttribute:

ApiId

attr_dns

A map of DNS names for the AppSync API.

CloudformationAttribute:

Dns

attr_dns_http

The domain name of the Api’s HTTP endpoint.

CloudformationAttribute:

Dns.Http

attr_dns_realtime

The domain name of the Api’s real-time endpoint.

CloudformationAttribute:

Dns.Realtime

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

event_config

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the Api .

node

The tree node.

owner_contact

The owner contact information for an API resource.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AuthModeProperty

class CfnApi.AuthModeProperty(*, auth_type=None)

Bases: object

Describes an authorization configuration.

Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

Parameters:

auth_type (Optional[str]) – The authorization type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authmode.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 import aws_appsync as appsync

auth_mode_property = appsync.CfnApi.AuthModeProperty(
    auth_type="authType"
)

Attributes

auth_type

The authorization type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authmode.html#cfn-appsync-api-authmode-authtype

AuthProviderProperty

class CfnApi.AuthProviderProperty(*, auth_type, cognito_config=None, lambda_authorizer_config=None, open_id_connect_config=None)

Bases: object

Describes an authorization provider.

Parameters:

  • auth_type (str) – The authorization type.

  • cognito_config (Union[IResolvable, CognitoConfigProperty, Dict[str, Any], None]) – Describes an Amazon Cognito user pool configuration.

  • lambda_authorizer_config (Union[IResolvable, LambdaAuthorizerConfigProperty, Dict[str, Any], None]) – A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

  • open_id_connect_config (Union[IResolvable, OpenIDConnectConfigProperty, Dict[str, Any], None]) – Describes an OpenID Connect (OIDC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.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 import aws_appsync as appsync

auth_provider_property = appsync.CfnApi.AuthProviderProperty(
    auth_type="authType",

    # the properties below are optional
    cognito_config=appsync.CfnApi.CognitoConfigProperty(
        aws_region="awsRegion",
        user_pool_id="userPoolId",

        # the properties below are optional
        app_id_client_regex="appIdClientRegex"
    ),
    lambda_authorizer_config=appsync.CfnApi.LambdaAuthorizerConfigProperty(
        authorizer_uri="authorizerUri",

        # the properties below are optional
        authorizer_result_ttl_in_seconds=123,
        identity_validation_expression="identityValidationExpression"
    ),
    open_id_connect_config=appsync.CfnApi.OpenIDConnectConfigProperty(
        issuer="issuer",

        # the properties below are optional
        auth_ttl=123,
        client_id="clientId",
        iat_ttl=123
    )
)

Attributes

auth_type

The authorization type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-authtype

cognito_config

Describes an Amazon Cognito user pool configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-cognitoconfig

lambda_authorizer_config

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-lambdaauthorizerconfig

open_id_connect_config

Describes an OpenID Connect (OIDC) configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-openidconnectconfig

CognitoConfigProperty

class CfnApi.CognitoConfigProperty(*, aws_region, user_pool_id, app_id_client_regex=None)

Bases: object

Describes an Amazon Cognito configuration.

Parameters:

  • aws_region (str) – The AWS Region in which the user pool was created.

  • user_pool_id (str) – The user pool ID.

  • app_id_client_regex (Optional[str]) – A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn’t set, no filtering is applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.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 import aws_appsync as appsync

cognito_config_property = appsync.CfnApi.CognitoConfigProperty(
    aws_region="awsRegion",
    user_pool_id="userPoolId",

    # the properties below are optional
    app_id_client_regex="appIdClientRegex"
)

Attributes

app_id_client_regex

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

If this value isn’t set, no filtering is applied.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-appidclientregex

aws_region

The AWS Region in which the user pool was created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-awsregion

user_pool_id

The user pool ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-userpoolid

DnsMapProperty

class CfnApi.DnsMapProperty(*, http=None, realtime=None)

Bases: object

A map of DNS names for the Api.

Parameters:

  • http (Optional[str]) – The domain name of the Api’s HTTP endpoint.

  • realtime (Optional[str]) – The domain name of the Api’s real-time endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-dnsmap.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 import aws_appsync as appsync

dns_map_property = appsync.CfnApi.DnsMapProperty(
    http="http",
    realtime="realtime"
)

Attributes

http

The domain name of the Api’s HTTP endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-dnsmap.html#cfn-appsync-api-dnsmap-http

realtime

The domain name of the Api’s real-time endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-dnsmap.html#cfn-appsync-api-dnsmap-realtime

EventConfigProperty

class CfnApi.EventConfigProperty(*, auth_providers, connection_auth_modes, default_publish_auth_modes, default_subscribe_auth_modes, log_config=None)

Bases: object

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

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventconfig.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 import aws_appsync as appsync

event_config_property = appsync.CfnApi.EventConfigProperty(
    auth_providers=[appsync.CfnApi.AuthProviderProperty(
        auth_type="authType",

        # the properties below are optional
        cognito_config=appsync.CfnApi.CognitoConfigProperty(
            aws_region="awsRegion",
            user_pool_id="userPoolId",

            # the properties below are optional
            app_id_client_regex="appIdClientRegex"
        ),
        lambda_authorizer_config=appsync.CfnApi.LambdaAuthorizerConfigProperty(
            authorizer_uri="authorizerUri",

            # the properties below are optional
            authorizer_result_ttl_in_seconds=123,
            identity_validation_expression="identityValidationExpression"
        ),
        open_id_connect_config=appsync.CfnApi.OpenIDConnectConfigProperty(
            issuer="issuer",

            # the properties below are optional
            auth_ttl=123,
            client_id="clientId",
            iat_ttl=123
        )
    )],
    connection_auth_modes=[appsync.CfnApi.AuthModeProperty(
        auth_type="authType"
    )],
    default_publish_auth_modes=[appsync.CfnApi.AuthModeProperty(
        auth_type="authType"
    )],
    default_subscribe_auth_modes=[appsync.CfnApi.AuthModeProperty(
        auth_type="authType"
    )],

    # the properties below are optional
    log_config=appsync.CfnApi.EventLogConfigProperty(
        cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
        log_level="logLevel"
    )
)

Attributes

auth_providers

A list of authorization providers.

See:

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

connection_auth_modes

A list of valid authorization modes for the Event API connections.

See:

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

default_publish_auth_modes

A list of valid authorization modes for the Event API publishing.

See:

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

default_subscribe_auth_modes

A list of valid authorization modes for the Event API subscriptions.

See:

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

log_config

The CloudWatch Logs configuration for the Event API.

See:

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

EventLogConfigProperty

class CfnApi.EventLogConfigProperty(*, cloud_watch_logs_role_arn, log_level)

Bases: object

Describes the CloudWatch Logs configuration for the Event API.

Parameters:

  • cloud_watch_logs_role_arn (str) – The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.

  • log_level (str) – The type of information to log for the Event API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.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 import aws_appsync as appsync

event_log_config_property = appsync.CfnApi.EventLogConfigProperty(
    cloud_watch_logs_role_arn="cloudWatchLogsRoleArn",
    log_level="logLevel"
)

Attributes

cloud_watch_logs_role_arn

The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.html#cfn-appsync-api-eventlogconfig-cloudwatchlogsrolearn

log_level

The type of information to log for the Event API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-eventlogconfig.html#cfn-appsync-api-eventlogconfig-loglevel

LambdaAuthorizerConfigProperty

class CfnApi.LambdaAuthorizerConfigProperty(*, authorizer_uri, authorizer_result_ttl_in_seconds=None, identity_validation_expression=None)

Bases: object

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

Parameters:

  • authorizer_uri (str) – The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN ( .../v3 ), or an alias ARN. Note : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the AWS Command Line Interface ( AWS CLI ), run the following: aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

  • authorizer_result_ttl_in_seconds (Union[int, float, None]) – The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

  • identity_validation_expression (Optional[str]) – A regular expression for validation of tokens before the Lambda function is called.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.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 import aws_appsync as appsync

lambda_authorizer_config_property = appsync.CfnApi.LambdaAuthorizerConfigProperty(
    authorizer_uri="authorizerUri",

    # the properties below are optional
    authorizer_result_ttl_in_seconds=123,
    identity_validation_expression="identityValidationExpression"
)

Attributes

authorizer_result_ttl_in_seconds

The number of seconds a response should be cached for.

The default is 0 seconds, which disables caching. If you don’t specify a value for authorizerResultTtlInSeconds , the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-authorizerresultttlinseconds

authorizer_uri

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization.

This can be a standard Lambda ARN, a version ARN ( .../v3 ), or an alias ARN.

Note : This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the AWS Command Line Interface ( AWS CLI ), run the following:

aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-authorizeruri

identity_validation_expression

A regular expression for validation of tokens before the Lambda function is called.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-lambdaauthorizerconfig.html#cfn-appsync-api-lambdaauthorizerconfig-identityvalidationexpression

OpenIDConnectConfigProperty

class CfnApi.OpenIDConnectConfigProperty(*, issuer, auth_ttl=None, client_id=None, iat_ttl=None)

Bases: object

Describes an OpenID Connect (OIDC) configuration.

Parameters:

  • issuer (str) – The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

  • auth_ttl (Union[int, float, None]) – The number of milliseconds that a token is valid after being authenticated.

  • client_id (Optional[str]) – The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AWS AppSync can validate against multiple client identifiers at a time.

  • iat_ttl (Union[int, float, None]) – The number of milliseconds that a token is valid after it’s issued to a user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.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 import aws_appsync as appsync

open_iDConnect_config_property = appsync.CfnApi.OpenIDConnectConfigProperty(
    issuer="issuer",

    # the properties below are optional
    auth_ttl=123,
    client_id="clientId",
    iat_ttl=123
)

Attributes

auth_ttl

The number of milliseconds that a token is valid after being authenticated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-authttl

client_id

The client identifier of the relying party at the OpenID identity provider.

This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AWS AppSync can validate against multiple client identifiers at a time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-clientid

iat_ttl

The number of milliseconds that a token is valid after it’s issued to a user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-iatttl

issuer

The issuer for the OIDC configuration.

The issuer returned by discovery must exactly match the value of iss in the ID token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-openidconnectconfig.html#cfn-appsync-api-openidconnectconfig-issuer