GradientEdge CDK Utils
    Preparing search index...

    Interface EventHandlerServiceBusNamespaceProps

    Properties for configuring the Service Bus namespace inside the event handler. Wraps ServiceBusNamespaceProps with a useExisting flag controlling whether the construct creates the namespace or resolves an existing one.

    interface EventHandlerServiceBusNamespaceProps {
        alternateName?: Input<string | undefined>;
        disableLocalAuth?: Input<boolean | undefined>;
        enableGeoReplication?: boolean;
        encryption?: Input<EncryptionArgs | undefined>;
        geoDataReplication?: Input<GeoDataReplicationPropertiesArgs | undefined>;
        geoReplication?: ServiceBusGeoReplicationProps;
        identity?: Input<IdentityArgs | undefined>;
        ipAddressType?: Input<string | undefined>;
        location?: Input<string | undefined>;
        minimumTlsVersion?: Input<string | undefined>;
        namespaceName?: Input<string | undefined>;
        platformCapabilities?: Input<PlatformCapabilitiesArgs | undefined>;
        premiumMessagingPartitions?: Input<number | undefined>;
        privateEndpointConnections?: Input<
            Input<PrivateEndpointConnectionArgs>[]
            | undefined,
        >;
        publicNetworkAccess?: Input<string | undefined>;
        resourceGroupName: Input<string>;
        sku?: Input<SBSkuArgs | undefined>;
        tags?: Input<{ [key: string]: Input<string> } | undefined>;
        useExisting?: boolean;
        zoneRedundant?: Input<boolean | undefined>;
    }

    Hierarchy (View Summary)

    Index
    alternateName? disableLocalAuth? enableGeoReplication? encryption? geoDataReplication? geoReplication? identity? ipAddressType? location? minimumTlsVersion? namespaceName? platformCapabilities? premiumMessagingPartitions? privateEndpointConnections? publicNetworkAccess? resourceGroupName sku? tags? useExisting? zoneRedundant?
    alternateName?: Input<string | undefined>

    Alternate name for namespace

    disableLocalAuth?: Input<boolean | undefined>

    This property disables SAS authentication for the Service Bus namespace.

    enableGeoReplication?: boolean

    Enables Service Bus geo-replication. Requires the namespace SKU to be Premium. When true, geoReplication must be supplied.

    encryption?: Input<EncryptionArgs | undefined>

    Properties of BYOK Encryption description

    geoDataReplication?: Input<GeoDataReplicationPropertiesArgs | undefined>

    Geo Data Replication settings for the namespace

    geoReplication?: ServiceBusGeoReplicationProps

    Geo-replication topology. Only consumed when enableGeoReplication is true.

    identity?: Input<IdentityArgs | undefined>

    Properties of BYOK Identity description

    ipAddressType?: Input<string | undefined>

    The IP address type for the namespace. Determines whether the namespace supports IPv4 only or both IPv4 and IPv6 (dual stack).

    location?: Input<string | undefined>

    The geo-location where the resource lives

    minimumTlsVersion?: Input<string | undefined>

    The minimum TLS version for the cluster to support, e.g. '1.2'

    namespaceName?: Input<string | undefined>

    The namespace name

    platformCapabilities?: Input<PlatformCapabilitiesArgs | undefined>
    premiumMessagingPartitions?: Input<number | undefined>

    The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4

    privateEndpointConnections?: Input<
        Input<PrivateEndpointConnectionArgs>[]
        | undefined,
    >

    List of private endpoint connections. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.

    publicNetworkAccess?: Input<string | undefined>

    This determines if traffic is allowed over public network. By default it is enabled.

    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    sku?: Input<SBSkuArgs | undefined>

    Properties of SKU

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

    Resource tags.

    useExisting?: boolean

    When true, resolves an existing namespace via getNamespaceOutput instead of creating one

    zoneRedundant?: Input<boolean | undefined>

    Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

    Settings
    Member Visibility

    On This Page
    Properties