1. Packages
  2. Nutanix
  3. API Docs
  4. getNdbProfile
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg

nutanix.getNdbProfile

Explore with Pulumi AI

nutanix logo
Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg

    Describes a profile in Nutanix Database Service

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pulumi/nutanix";
    
    const profile1 = nutanix.getNdbProfile({
        profileType: "Network",
        profileName: "TEST_NETWORK_PROFILE",
    });
    export const profile = profile1;
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    profile1 = nutanix.get_ndb_profile(profile_type="Network",
        profile_name="TEST_NETWORK_PROFILE")
    pulumi.export("profile", profile1)
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		profile1, err := nutanix.LookupNdbProfile(ctx, &nutanix.LookupNdbProfileArgs{
    			ProfileType: pulumi.StringRef("Network"),
    			ProfileName: pulumi.StringRef("TEST_NETWORK_PROFILE"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("profile", profile1)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var profile1 = Nutanix.GetNdbProfile.Invoke(new()
        {
            ProfileType = "Network",
            ProfileName = "TEST_NETWORK_PROFILE",
        });
    
        return new Dictionary<string, object?>
        {
            ["profile"] = profile1,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NutanixFunctions;
    import com.pulumi.nutanix.inputs.GetNdbProfileArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var profile1 = NutanixFunctions.getNdbProfile(GetNdbProfileArgs.builder()
                .profileType("Network")
                .profileName("TEST_NETWORK_PROFILE")
                .build());
    
            ctx.export("profile", profile1.applyValue(getNdbProfileResult -> getNdbProfileResult));
        }
    }
    
    variables:
      profile1:
        fn::invoke:
          Function: nutanix:getNdbProfile
          Arguments:
            profileType: Network
            profileName: TEST_NETWORK_PROFILE
    outputs:
      profile: ${profile1}
    

    Using getNdbProfile

    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 getNdbProfile(args: GetNdbProfileArgs, opts?: InvokeOptions): Promise<GetNdbProfileResult>
    function getNdbProfileOutput(args: GetNdbProfileOutputArgs, opts?: InvokeOptions): Output<GetNdbProfileResult>
    def get_ndb_profile(engine: Optional[str] = None,
                        profile_id: Optional[str] = None,
                        profile_name: Optional[str] = None,
                        profile_type: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetNdbProfileResult
    def get_ndb_profile_output(engine: Optional[pulumi.Input[str]] = None,
                        profile_id: Optional[pulumi.Input[str]] = None,
                        profile_name: Optional[pulumi.Input[str]] = None,
                        profile_type: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetNdbProfileResult]
    func LookupNdbProfile(ctx *Context, args *LookupNdbProfileArgs, opts ...InvokeOption) (*LookupNdbProfileResult, error)
    func LookupNdbProfileOutput(ctx *Context, args *LookupNdbProfileOutputArgs, opts ...InvokeOption) LookupNdbProfileResultOutput

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

    public static class GetNdbProfile 
    {
        public static Task<GetNdbProfileResult> InvokeAsync(GetNdbProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetNdbProfileResult> Invoke(GetNdbProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNdbProfileResult> getNdbProfile(GetNdbProfileArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nutanix:index/getNdbProfile:getNdbProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Engine string
    Database engine. For eg. postgres_database
    ProfileId string
    Profile ID for query
    ProfileName string
    Profile Name for query
    ProfileType string
    Profile type. Types: Software, Compute, Network and Database_Parameter
    Engine string
    Database engine. For eg. postgres_database
    ProfileId string
    Profile ID for query
    ProfileName string
    Profile Name for query
    ProfileType string
    Profile type. Types: Software, Compute, Network and Database_Parameter
    engine String
    Database engine. For eg. postgres_database
    profileId String
    Profile ID for query
    profileName String
    Profile Name for query
    profileType String
    Profile type. Types: Software, Compute, Network and Database_Parameter
    engine string
    Database engine. For eg. postgres_database
    profileId string
    Profile ID for query
    profileName string
    Profile Name for query
    profileType string
    Profile type. Types: Software, Compute, Network and Database_Parameter
    engine str
    Database engine. For eg. postgres_database
    profile_id str
    Profile ID for query
    profile_name str
    Profile Name for query
    profile_type str
    Profile type. Types: Software, Compute, Network and Database_Parameter
    engine String
    Database engine. For eg. postgres_database
    profileId String
    Profile ID for query
    profileName String
    Profile Name for query
    profileType String
    Profile type. Types: Software, Compute, Network and Database_Parameter

    getNdbProfile Result

    The following output properties are available:

    AssocDatabases List<string>
    • associated databases
    AssocDbServers List<string>
    • associated DB servers
    ClusterAvailabilities List<PiersKarsenbarg.Nutanix.Outputs.GetNdbProfileClusterAvailability>
    • list of clusters availability
    DbVersion string
    • database version
    Description string
    • description of profile
    EngineType string
    • database engine type
    Id string
    • id of profile
    LatestVersion string
    • latest version for engine software
    LatestVersionId string
    • ID of latest version for engine software
    Name string
    • profile name
    NxClusterId string
    • era cluster ID
    Owner string
    • owner name
    Status string
    • status of profile
    SystemProfile bool
    • if system profile or not
    Topology string
    • topology
    Type string
    Versions List<PiersKarsenbarg.Nutanix.Outputs.GetNdbProfileVersion>
    • profile's different version config
    Engine string
    ProfileId string
    ProfileName string
    ProfileType string
    AssocDatabases []string
    • associated databases
    AssocDbServers []string
    • associated DB servers
    ClusterAvailabilities []GetNdbProfileClusterAvailability
    • list of clusters availability
    DbVersion string
    • database version
    Description string
    • description of profile
    EngineType string
    • database engine type
    Id string
    • id of profile
    LatestVersion string
    • latest version for engine software
    LatestVersionId string
    • ID of latest version for engine software
    Name string
    • profile name
    NxClusterId string
    • era cluster ID
    Owner string
    • owner name
    Status string
    • status of profile
    SystemProfile bool
    • if system profile or not
    Topology string
    • topology
    Type string
    Versions []GetNdbProfileVersion
    • profile's different version config
    Engine string
    ProfileId string
    ProfileName string
    ProfileType string
    assocDatabases List<String>
    • associated databases
    assocDbServers List<String>
    • associated DB servers
    clusterAvailabilities List<GetNdbProfileClusterAvailability>
    • list of clusters availability
    dbVersion String
    • database version
    description String
    • description of profile
    engineType String
    • database engine type
    id String
    • id of profile
    latestVersion String
    • latest version for engine software
    latestVersionId String
    • ID of latest version for engine software
    name String
    • profile name
    nxClusterId String
    • era cluster ID
    owner String
    • owner name
    status String
    • status of profile
    systemProfile Boolean
    • if system profile or not
    topology String
    • topology
    type String
    versions List<GetNdbProfileVersion>
    • profile's different version config
    engine String
    profileId String
    profileName String
    profileType String
    assocDatabases string[]
    • associated databases
    assocDbServers string[]
    • associated DB servers
    clusterAvailabilities GetNdbProfileClusterAvailability[]
    • list of clusters availability
    dbVersion string
    • database version
    description string
    • description of profile
    engineType string
    • database engine type
    id string
    • id of profile
    latestVersion string
    • latest version for engine software
    latestVersionId string
    • ID of latest version for engine software
    name string
    • profile name
    nxClusterId string
    • era cluster ID
    owner string
    • owner name
    status string
    • status of profile
    systemProfile boolean
    • if system profile or not
    topology string
    • topology
    type string
    versions GetNdbProfileVersion[]
    • profile's different version config
    engine string
    profileId string
    profileName string
    profileType string
    assoc_databases Sequence[str]
    • associated databases
    assoc_db_servers Sequence[str]
    • associated DB servers
    cluster_availabilities Sequence[GetNdbProfileClusterAvailability]
    • list of clusters availability
    db_version str
    • database version
    description str
    • description of profile
    engine_type str
    • database engine type
    id str
    • id of profile
    latest_version str
    • latest version for engine software
    latest_version_id str
    • ID of latest version for engine software
    name str
    • profile name
    nx_cluster_id str
    • era cluster ID
    owner str
    • owner name
    status str
    • status of profile
    system_profile bool
    • if system profile or not
    topology str
    • topology
    type str
    versions Sequence[GetNdbProfileVersion]
    • profile's different version config
    engine str
    profile_id str
    profile_name str
    profile_type str
    assocDatabases List<String>
    • associated databases
    assocDbServers List<String>
    • associated DB servers
    clusterAvailabilities List<Property Map>
    • list of clusters availability
    dbVersion String
    • database version
    description String
    • description of profile
    engineType String
    • database engine type
    id String
    • id of profile
    latestVersion String
    • latest version for engine software
    latestVersionId String
    • ID of latest version for engine software
    name String
    • profile name
    nxClusterId String
    • era cluster ID
    owner String
    • owner name
    status String
    • status of profile
    systemProfile Boolean
    • if system profile or not
    topology String
    • topology
    type String
    versions List<Property Map>
    • profile's different version config
    engine String
    profileId String
    profileName String
    profileType String

    Supporting Types

    GetNdbProfileClusterAvailability

    DateCreated string
    DateModified string
    NxClusterId string
    • era cluster ID
    OwnerId string
    ProfileId string
    Profile ID for query
    Status string
    • status of profile
    DateCreated string
    DateModified string
    NxClusterId string
    • era cluster ID
    OwnerId string
    ProfileId string
    Profile ID for query
    Status string
    • status of profile
    dateCreated String
    dateModified String
    nxClusterId String
    • era cluster ID
    ownerId String
    profileId String
    Profile ID for query
    status String
    • status of profile
    dateCreated string
    dateModified string
    nxClusterId string
    • era cluster ID
    ownerId string
    profileId string
    Profile ID for query
    status string
    • status of profile
    date_created str
    date_modified str
    nx_cluster_id str
    • era cluster ID
    owner_id str
    profile_id str
    Profile ID for query
    status str
    • status of profile
    dateCreated String
    dateModified String
    nxClusterId String
    • era cluster ID
    ownerId String
    profileId String
    Profile ID for query
    status String
    • status of profile

    GetNdbProfileVersion

    DbVersion string
    • database version
    Deprecated bool
    Description string
    • description of profile
    EngineType string
    • database engine type
    Id string
    • id of profile
    Name string
    • profile name
    Owner string
    • owner name
    ProfileId string
    Profile ID for query
    Properties List<PiersKarsenbarg.Nutanix.Inputs.GetNdbProfileVersionProperty>
    PropertiesMap Dictionary<string, string>
    Published bool
    Status string
    • status of profile
    SystemProfile bool
    • if system profile or not
    Topology string
    • topology
    Type string
    Version string
    VersionClusterAssociations List<PiersKarsenbarg.Nutanix.Inputs.GetNdbProfileVersionVersionClusterAssociation>
    DbVersion string
    • database version
    Deprecated bool
    Description string
    • description of profile
    EngineType string
    • database engine type
    Id string
    • id of profile
    Name string
    • profile name
    Owner string
    • owner name
    ProfileId string
    Profile ID for query
    Properties []GetNdbProfileVersionProperty
    PropertiesMap map[string]string
    Published bool
    Status string
    • status of profile
    SystemProfile bool
    • if system profile or not
    Topology string
    • topology
    Type string
    Version string
    VersionClusterAssociations []GetNdbProfileVersionVersionClusterAssociation
    dbVersion String
    • database version
    deprecated Boolean
    description String
    • description of profile
    engineType String
    • database engine type
    id String
    • id of profile
    name String
    • profile name
    owner String
    • owner name
    profileId String
    Profile ID for query
    properties List<GetNdbProfileVersionProperty>
    propertiesMap Map<String,String>
    published Boolean
    status String
    • status of profile
    systemProfile Boolean
    • if system profile or not
    topology String
    • topology
    type String
    version String
    versionClusterAssociations List<GetNdbProfileVersionVersionClusterAssociation>
    dbVersion string
    • database version
    deprecated boolean
    description string
    • description of profile
    engineType string
    • database engine type
    id string
    • id of profile
    name string
    • profile name
    owner string
    • owner name
    profileId string
    Profile ID for query
    properties GetNdbProfileVersionProperty[]
    propertiesMap {[key: string]: string}
    published boolean
    status string
    • status of profile
    systemProfile boolean
    • if system profile or not
    topology string
    • topology
    type string
    version string
    versionClusterAssociations GetNdbProfileVersionVersionClusterAssociation[]
    db_version str
    • database version
    deprecated bool
    description str
    • description of profile
    engine_type str
    • database engine type
    id str
    • id of profile
    name str
    • profile name
    owner str
    • owner name
    profile_id str
    Profile ID for query
    properties Sequence[GetNdbProfileVersionProperty]
    properties_map Mapping[str, str]
    published bool
    status str
    • status of profile
    system_profile bool
    • if system profile or not
    topology str
    • topology
    type str
    version str
    version_cluster_associations Sequence[GetNdbProfileVersionVersionClusterAssociation]
    dbVersion String
    • database version
    deprecated Boolean
    description String
    • description of profile
    engineType String
    • database engine type
    id String
    • id of profile
    name String
    • profile name
    owner String
    • owner name
    profileId String
    Profile ID for query
    properties List<Property Map>
    propertiesMap Map<String>
    published Boolean
    status String
    • status of profile
    systemProfile Boolean
    • if system profile or not
    topology String
    • topology
    type String
    version String
    versionClusterAssociations List<Property Map>

    GetNdbProfileVersionProperty

    Name string
    • profile name
    Secure bool
    Value string
    Name string
    • profile name
    Secure bool
    Value string
    name String
    • profile name
    secure Boolean
    value String
    name string
    • profile name
    secure boolean
    value string
    name str
    • profile name
    secure bool
    value str
    name String
    • profile name
    secure Boolean
    value String

    GetNdbProfileVersionVersionClusterAssociation

    dateCreated String
    dateModified String
    nxClusterId String
    • era cluster ID
    optimizedForProvisioning Boolean
    ownerId String
    profileVersionId String
    properties List<Property Map>
    status String
    • status of profile

    GetNdbProfileVersionVersionClusterAssociationProperty

    Name string
    • profile name
    Secure bool
    Value string
    Name string
    • profile name
    Secure bool
    Value string
    name String
    • profile name
    secure Boolean
    value String
    name string
    • profile name
    secure boolean
    value string
    name str
    • profile name
    secure bool
    value str
    name String
    • profile name
    secure Boolean
    value String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.1.0 published on Tuesday, Sep 24, 2024 by Piers Karsenbarg