GradientEdge CDK Utils
    Preparing search index...

    Interface CosmosdbAccountProps

    interface CosmosdbAccountProps {
        accountName?: Input<string>;
        analyticalStorageConfiguration?: Input<AnalyticalStorageConfigurationArgs>;
        apiProperties?: Input<ApiPropertiesArgs>;
        backupPolicy?: Input<
            ContinuousModeBackupPolicyArgs
            | PeriodicModeBackupPolicyArgs,
        >;
        capabilities?: Input<Input<CapabilityArgs>[]>;
        capacity?: Input<CapacityArgs>;
        connectorOffer?: Input<string>;
        consistencyPolicy?: Input<ConsistencyPolicyArgs>;
        cors?: Input<Input<CorsPolicyArgs>[]>;
        createMode?: Input<string>;
        customerManagedKeyStatus?: Input<string>;
        databaseAccountOfferType: Input<"Standard">;
        defaultIdentity?: Input<string>;
        defaultPriorityLevel?: Input<string>;
        disableKeyBasedMetadataWriteAccess?: Input<boolean>;
        disableLocalAuth?: Input<boolean>;
        enableAnalyticalStorage?: Input<boolean>;
        enableAutomaticFailover?: Input<boolean>;
        enableBurstCapacity?: Input<boolean>;
        enableCassandraConnector?: Input<boolean>;
        enableFreeTier?: Input<boolean>;
        enableMultipleWriteLocations?: Input<boolean>;
        enablePartitionMerge?: Input<boolean>;
        enablePerRegionPerPartitionAutoscale?: Input<boolean>;
        enablePriorityBasedExecution?: Input<boolean>;
        identity?: Input<ManagedServiceIdentityArgs>;
        ipRules?: Input<Input<IpAddressOrRangeArgs>[]>;
        isVirtualNetworkFilterEnabled?: Input<boolean>;
        keyVaultKeyUri?: Input<string>;
        kind?: Input<string>;
        location?: Input<string>;
        locations: Input<Input<LocationArgs>[]>;
        minimalTlsVersion?: Input<string>;
        networkAclBypass?: Input<NetworkAclBypass>;
        networkAclBypassResourceIds?: Input<Input<string>[]>;
        publicNetworkAccess?: Input<string>;
        resourceGroupName: Input<string>;
        restoreParameters?: Input<RestoreParametersArgs>;
        tags?: Input<{ [key: string]: Input<string> }>;
        virtualNetworkRules?: Input<Input<VirtualNetworkRuleArgs>[]>;
    }

    Hierarchy

    • DatabaseAccountArgs
      • CosmosdbAccountProps
    Index

    Properties

    accountName? analyticalStorageConfiguration? apiProperties? backupPolicy? capabilities? capacity? connectorOffer? consistencyPolicy? cors? createMode? customerManagedKeyStatus? databaseAccountOfferType defaultIdentity? defaultPriorityLevel? disableKeyBasedMetadataWriteAccess? disableLocalAuth? enableAnalyticalStorage? enableAutomaticFailover? enableBurstCapacity? enableCassandraConnector? enableFreeTier? enableMultipleWriteLocations? enablePartitionMerge? enablePerRegionPerPartitionAutoscale? enablePriorityBasedExecution? identity? ipRules? isVirtualNetworkFilterEnabled? keyVaultKeyUri? kind? location? locations minimalTlsVersion? networkAclBypass? networkAclBypassResourceIds? publicNetworkAccess? resourceGroupName restoreParameters? tags? virtualNetworkRules?

    Properties

    accountName?: Input<string>

    Cosmos DB database account name.

    analyticalStorageConfiguration?: Input<AnalyticalStorageConfigurationArgs>

    Analytical storage specific properties.

    apiProperties?: Input<ApiPropertiesArgs>

    API specific properties. Currently, supported only for MongoDB API.

    backupPolicy?: Input<
        ContinuousModeBackupPolicyArgs
        | PeriodicModeBackupPolicyArgs,
    >

    The object representing the policy for taking backups on an account.

    capabilities?: Input<Input<CapabilityArgs>[]>

    List of Cosmos DB capabilities for the account

    capacity?: Input<CapacityArgs>

    The object that represents all properties related to capacity enforcement on an account.

    connectorOffer?: Input<string>

    The cassandra connector offer type for the Cosmos DB database C* account.

    consistencyPolicy?: Input<ConsistencyPolicyArgs>

    The consistency policy for the Cosmos DB account.

    cors?: Input<Input<CorsPolicyArgs>[]>

    The CORS policy for the Cosmos DB database account.

    createMode?: Input<string>

    Enum to indicate the mode of account creation.

    customerManagedKeyStatus?: Input<string>

    Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.

    databaseAccountOfferType: Input<"Standard">

    The offer type for the database

    defaultIdentity?: Input<string>

    The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.

    defaultPriorityLevel?: Input<string>

    Enum to indicate default Priority Level of request for Priority Based Execution.

    disableKeyBasedMetadataWriteAccess?: Input<boolean>

    Disable write operations on metadata resources (databases, containers, throughput) via account keys

    disableLocalAuth?: Input<boolean>

    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.

    enableAnalyticalStorage?: Input<boolean>

    Flag to indicate whether to enable storage analytics.

    enableAutomaticFailover?: Input<boolean>

    Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

    enableBurstCapacity?: Input<boolean>

    Flag to indicate enabling/disabling of Burst Capacity feature on the account

    enableCassandraConnector?: Input<boolean>

    Enables the cassandra connector on the Cosmos DB C* account

    enableFreeTier?: Input<boolean>

    Flag to indicate whether Free Tier is enabled.

    enableMultipleWriteLocations?: Input<boolean>

    Enables the account to write in multiple locations

    enablePartitionMerge?: Input<boolean>

    Flag to indicate enabling/disabling of Partition Merge feature on the account

    enablePerRegionPerPartitionAutoscale?: Input<boolean>

    Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account

    enablePriorityBasedExecution?: Input<boolean>

    Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account

    identity?: Input<ManagedServiceIdentityArgs>

    Identity for the resource.

    ipRules?: Input<Input<IpAddressOrRangeArgs>[]>

    List of IpRules.

    isVirtualNetworkFilterEnabled?: Input<boolean>

    Flag to indicate whether to enable/disable Virtual Network ACL rules.

    keyVaultKeyUri?: Input<string>

    The URI of the key vault

    kind?: Input<string>

    Indicates the type of database account. This can only be set at database account creation.

    location?: Input<string>

    The location of the resource group to which the resource belongs.

    locations: Input<Input<LocationArgs>[]>

    An array that contains the georeplication locations enabled for the Cosmos DB account.

    minimalTlsVersion?: Input<string>

    Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.

    networkAclBypass?: Input<NetworkAclBypass>

    Indicates what services are allowed to bypass firewall checks.

    networkAclBypassResourceIds?: Input<Input<string>[]>

    An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

    publicNetworkAccess?: Input<string>

    Whether requests from Public Network are allowed

    resourceGroupName: Input<string>

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

    restoreParameters?: Input<RestoreParametersArgs>

    Parameters to indicate the information about the restore.

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

    Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

    virtualNetworkRules?: Input<Input<VirtualNetworkRuleArgs>[]>

    List of Virtual Network ACL rules configured for the Cosmos DB account.

    Settings

    Member Visibility

    On This Page

    Properties