1. Packages
  2. Astra DB
  3. API Docs
  4. getAstraDatabases
Astra DB v1.0.39 published on Wednesday, May 24, 2023 by pulumiverse

astra.getAstraDatabases

Explore with Pulumi AI

astra logo
Astra DB v1.0.39 published on Wednesday, May 24, 2023 by pulumiverse

    astra.getAstraDatabases provides a datasource for a list of Astra databases. This can be used to select databases within your Astra Organization.

    Using getAstraDatabases

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAstraDatabases(args: GetAstraDatabasesArgs, opts?: InvokeOptions): Promise<GetAstraDatabasesResult>
    function getAstraDatabasesOutput(args: GetAstraDatabasesOutputArgs, opts?: InvokeOptions): Output<GetAstraDatabasesResult>
    def get_astra_databases(cloud_provider: Optional[str] = None,
                            status: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAstraDatabasesResult
    def get_astra_databases_output(cloud_provider: Optional[pulumi.Input[str]] = None,
                            status: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAstraDatabasesResult]
    func LookupAstraDatabases(ctx *Context, args *LookupAstraDatabasesArgs, opts ...InvokeOption) (*LookupAstraDatabasesResult, error)
    func LookupAstraDatabasesOutput(ctx *Context, args *LookupAstraDatabasesOutputArgs, opts ...InvokeOption) LookupAstraDatabasesResultOutput

    > Note: This function is named LookupAstraDatabases in the Go SDK.

    public static class GetAstraDatabases 
    {
        public static Task<GetAstraDatabasesResult> InvokeAsync(GetAstraDatabasesArgs args, InvokeOptions? opts = null)
        public static Output<GetAstraDatabasesResult> Invoke(GetAstraDatabasesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAstraDatabasesResult> getAstraDatabases(GetAstraDatabasesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: astra:index/getAstraDatabases:getAstraDatabases
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CloudProvider string

    The cloud provider

    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    CloudProvider string

    The cloud provider

    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    cloudProvider String

    The cloud provider

    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    cloudProvider string

    The cloud provider

    status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    cloud_provider str

    The cloud provider

    status str

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    cloudProvider String

    The cloud provider

    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    getAstraDatabases Result

    The following output properties are available:

    Id string

    The provider-assigned unique ID for this managed resource.

    Results List<Pulumiverse.Astra.Outputs.GetAstraDatabasesResult>

    The list of Astra databases that match the search criteria.

    CloudProvider string

    The cloud provider

    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    Id string

    The provider-assigned unique ID for this managed resource.

    Results []GetAstraDatabasesResult

    The list of Astra databases that match the search criteria.

    CloudProvider string

    The cloud provider

    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    id String

    The provider-assigned unique ID for this managed resource.

    results List<GetAstraDatabasesResult>

    The list of Astra databases that match the search criteria.

    cloudProvider String

    The cloud provider

    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    id string

    The provider-assigned unique ID for this managed resource.

    results GetAstraDatabasesResult[]

    The list of Astra databases that match the search criteria.

    cloudProvider string

    The cloud provider

    status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    id str

    The provider-assigned unique ID for this managed resource.

    results Sequence[GetAstraDatabasesResult]

    The list of Astra databases that match the search criteria.

    cloud_provider str

    The cloud provider

    status str

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    id String

    The provider-assigned unique ID for this managed resource.

    results List<Property Map>

    The list of Astra databases that match the search criteria.

    cloudProvider String

    The cloud provider

    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    Supporting Types

    GetAstraDatabasesResult

    AdditionalKeyspaces List<string>
    CloudProvider string

    The cloud provider

    CqlshUrl string
    DataEndpointUrl string
    Datacenters Dictionary<string, string>
    GrafanaUrl string
    GraphqlUrl string
    Id string

    The ID of this resource.

    Keyspace string
    Name string
    NodeCount int
    OrganizationId string
    OwnerId string
    Regions List<string>
    ReplicationFactor int
    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    TotalStorage int
    AdditionalKeyspaces []string
    CloudProvider string

    The cloud provider

    CqlshUrl string
    DataEndpointUrl string
    Datacenters map[string]string
    GrafanaUrl string
    GraphqlUrl string
    Id string

    The ID of this resource.

    Keyspace string
    Name string
    NodeCount int
    OrganizationId string
    OwnerId string
    Regions []string
    ReplicationFactor int
    Status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    TotalStorage int
    additionalKeyspaces List<String>
    cloudProvider String

    The cloud provider

    cqlshUrl String
    dataEndpointUrl String
    datacenters Map<String,String>
    grafanaUrl String
    graphqlUrl String
    id String

    The ID of this resource.

    keyspace String
    name String
    nodeCount Integer
    organizationId String
    ownerId String
    regions List<String>
    replicationFactor Integer
    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    totalStorage Integer
    additionalKeyspaces string[]
    cloudProvider string

    The cloud provider

    cqlshUrl string
    dataEndpointUrl string
    datacenters {[key: string]: string}
    grafanaUrl string
    graphqlUrl string
    id string

    The ID of this resource.

    keyspace string
    name string
    nodeCount number
    organizationId string
    ownerId string
    regions string[]
    replicationFactor number
    status string

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    totalStorage number
    additional_keyspaces Sequence[str]
    cloud_provider str

    The cloud provider

    cqlsh_url str
    data_endpoint_url str
    datacenters Mapping[str, str]
    grafana_url str
    graphql_url str
    id str

    The ID of this resource.

    keyspace str
    name str
    node_count int
    organization_id str
    owner_id str
    regions Sequence[str]
    replication_factor int
    status str

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    total_storage int
    additionalKeyspaces List<String>
    cloudProvider String

    The cloud provider

    cqlshUrl String
    dataEndpointUrl String
    datacenters Map<String>
    grafanaUrl String
    graphqlUrl String
    id String

    The ID of this resource.

    keyspace String
    name String
    nodeCount Number
    organizationId String
    ownerId String
    regions List<String>
    replicationFactor Number
    status String

    Status flter. Only return databases with matching status, if supplied. Otherwise return all databases matching other requirements

    totalStorage Number

    Package Details

    Repository
    astra pulumiverse/pulumi-astra
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the astra Terraform Provider.

    astra logo
    Astra DB v1.0.39 published on Wednesday, May 24, 2023 by pulumiverse