GradientEdge CDK Utils
    Preparing search index...

    Interface EventHandlerEventGridTopicProps

    Properties for configuring the EventGrid topic in the event handler

    interface EventHandlerEventGridTopicProps {
        dataResidencyBoundary?: Input<string>;
        disableLocalAuth?: Input<boolean>;
        eventTypeInfo?: Input<EventTypeInfoArgs>;
        existingResourceGroupName?: Input<string>;
        existingSubscriptionId?: string;
        existingTopicName?: string;
        identity?: Input<IdentityInfoArgs>;
        inboundIpRules?: Input<Input<InboundIpRuleArgs>[]>;
        inputSchema?: Input<string>;
        inputSchemaMapping?: Input<JsonInputSchemaMappingArgs>;
        location?: Input<string>;
        minimumTlsVersionAllowed?: Input<string>;
        publicNetworkAccess?: Input<string>;
        resourceGroupName: Input<string>;
        tags?: Input<{ [key: string]: Input<string> }>;
        topicName?: Input<string>;
        useExistingTopic: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataResidencyBoundary? disableLocalAuth? eventTypeInfo? existingResourceGroupName? existingSubscriptionId? existingTopicName? identity? inboundIpRules? inputSchema? inputSchemaMapping? location? minimumTlsVersionAllowed? publicNetworkAccess? resourceGroupName tags? topicName? useExistingTopic

    Properties

    dataResidencyBoundary?: Input<string>

    Data Residency Boundary of the resource.

    disableLocalAuth?: Input<boolean>

    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.

    eventTypeInfo?: Input<EventTypeInfoArgs>

    Event Type Information for the user topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

    existingResourceGroupName?: Input<string>

    Resource group name of the existing EventGrid topic

    existingSubscriptionId?: string

    Subscription ID of the existing EventGrid topic (for cross-subscription access)

    existingTopicName?: string

    Name of the existing EventGrid topic to resolve

    identity?: Input<IdentityInfoArgs>

    Identity information for the resource.

    inboundIpRules?: Input<Input<InboundIpRuleArgs>[]>

    This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

    inputSchema?: Input<string>

    This determines the format that Event Grid should expect for incoming events published to the topic.

    inputSchemaMapping?: Input<JsonInputSchemaMappingArgs>

    This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

    location?: Input<string>

    Location of the resource.

    minimumTlsVersionAllowed?: Input<string>

    Minimum TLS version of the publisher allowed to publish to this topic

    publicNetworkAccess?: Input<string>

    This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

    resourceGroupName: Input<string>

    The name of the resource group within the user's subscription.

    tags?: Input<{ [key: string]: Input<string> }>

    Tags of the resource.

    topicName?: Input<string>

    Name of the topic.

    useExistingTopic: boolean

    When true, resolves an existing EventGrid topic instead of creating a new one

    Settings

    Member Visibility

    On This Page

    Properties