1. Packages
  2. Hsdp Provider
  3. API Docs
  4. getConfig
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.getConfig

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Retrieve configuration details from services based on region and environment

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const iamUsEastProd = hsdp.getConfig({
        environment: "prod",
        region: "us-east",
        service: "iam",
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    iam_us_east_prod = hsdp.get_config(environment="prod",
        region="us-east",
        service="iam")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.GetConfig(ctx, &hsdp.GetConfigArgs{
    			Environment: pulumi.StringRef("prod"),
    			Region:      pulumi.StringRef("us-east"),
    			Service:     "iam",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var iamUsEastProd = Hsdp.GetConfig.Invoke(new()
        {
            Environment = "prod",
            Region = "us-east",
            Service = "iam",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.HsdpFunctions;
    import com.pulumi.hsdp.inputs.GetConfigArgs;
    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 iamUsEastProd = HsdpFunctions.getConfig(GetConfigArgs.builder()
                .environment("prod")
                .region("us-east")
                .service("iam")
                .build());
    
        }
    }
    
    variables:
      iamUsEastProd:
        fn::invoke:
          function: hsdp:getConfig
          arguments:
            environment: prod
            region: us-east
            service: iam
    
    import * as pulumi from "@pulumi/pulumi";
    
    export const iamUrlUsEastProd = data.hsdp_config.iam_us_east_prod.url;
    
    import pulumi
    
    pulumi.export("iamUrlUsEastProd", data["hsdp_config"]["iam_us_east_prod"]["url"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ctx.Export("iamUrlUsEastProd", data.Hsdp_config.Iam_us_east_prod.Url)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
        return new Dictionary<string, object?>
        {
            ["iamUrlUsEastProd"] = data.Hsdp_config.Iam_us_east_prod.Url,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
            ctx.export("iamUrlUsEastProd", data.hsdp_config().iam_us_east_prod().url());
        }
    }
    
    outputs:
      iamUrlUsEastProd: ${data.hsdp_config.iam_us_east_prod.url}
    

    Using getConfig

    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 getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
    function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>
    def get_config(environment: Optional[str] = None,
                   id: Optional[str] = None,
                   region: Optional[str] = None,
                   service: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConfigResult
    def get_config_output(environment: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   region: Optional[pulumi.Input[str]] = None,
                   service: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]
    func GetConfig(ctx *Context, args *GetConfigArgs, opts ...InvokeOption) (*GetConfigResult, error)
    func GetConfigOutput(ctx *Context, args *GetConfigOutputArgs, opts ...InvokeOption) GetConfigResultOutput

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

    public static class GetConfig 
    {
        public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    public static Output<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: hsdp:index/getConfig:getConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Service string

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    Environment string

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    Id string
    Region string

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    Service string

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    Environment string

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    Id string
    Region string

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    service String

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    environment String

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    id String
    region String

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    service string

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    environment string

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    id string
    region string

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    service str

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    environment str

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    id str
    region str

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    service String

    The HSDP service to lookup

    Availability of services varies across regions. The following services are discoverable:

    | Service | Description | |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | cartel | The Cartel API service. Manages Container Host instances | | cf | HSDP Cloud foundry regional PaaS configuration | | console | HSDP Console API endpoints | | docker-registry | Regional Docker Registry details | | gateway | Regional SSH gateway details | | has | Hosted Application Streaming HAS | | iam | Identity and Access Management IAM | | idm | Identity and User Management. Part of IAM | | kibana | Kibana endpoint. Part of HSDP Logging | | logging | HSDP Logging API details | | logquery | Log query endpoint details. Part of HSDP Logging | | mdm | Master Data Management MDM | | notification | HSDP Notification service | | pki | Public Key Infrastructure PKI services | | s3creds | S3 Credentials API details | | edge | Edge / STL API details | | uaa | User Account and Authentication UAA. Part of Cloud foundry | | vault-proxy | Vault proxy details. Part of Vault Service Broker |

    environment String

    The HSDP environment. If not set, defaults to provider level config

    Environments vary across regions. The following environemnts are valid

    | Environment | Description | |-------------|---------------------------------------| | dev | Development. Only in region us-east | | client-test | Client Test / Development environment | | prod | Production |

    id String
    region String

    The HSDP region. If not set, defaults to provider level config

    The following regions are recognized:

    | Region | Description | |---------|--------------------------------------------------------------------------| | apac2 | Japan (Tokyo) | | apac3 | Asia-Pacific (Sydney) | | ca1 | Canada (Central Canada) | | cn1 | China (Beijing) | | dev | Development (US) | | eu-west | European Union (Ireland) | | sa1 | South America (Sao Paulo) | | us-east | United States (Virginia) | | pl | HealthSuite Extended Platform with PrivateLink (pl) endpoints |

    The pl region only has a limited subset of mapped services (logging)

    getConfig Result

    The following output properties are available:

    Domain string
    (string) The domain associated with the service
    Host string
    (string) The host of the service
    Id string
    OrgAdminUsername string
    (string) The IAM OrgAdmin used for authenticating against IAM
    Regions List<string>
    (string) The list of known regions
    Service string
    ServiceId string
    (string) The IAM service ID used for authenticating against IAM
    Services List<string>
    (list(string)) The list of available services in the region/environment
    SlidingExpiresOn string
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    Url string
    (string) The (base / API) URL of the service
    Environment string
    Region string
    Domain string
    (string) The domain associated with the service
    Host string
    (string) The host of the service
    Id string
    OrgAdminUsername string
    (string) The IAM OrgAdmin used for authenticating against IAM
    Regions []string
    (string) The list of known regions
    Service string
    ServiceId string
    (string) The IAM service ID used for authenticating against IAM
    Services []string
    (list(string)) The list of available services in the region/environment
    SlidingExpiresOn string
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    Url string
    (string) The (base / API) URL of the service
    Environment string
    Region string
    domain String
    (string) The domain associated with the service
    host String
    (string) The host of the service
    id String
    orgAdminUsername String
    (string) The IAM OrgAdmin used for authenticating against IAM
    regions List<String>
    (string) The list of known regions
    service String
    serviceId String
    (string) The IAM service ID used for authenticating against IAM
    services List<String>
    (list(string)) The list of available services in the region/environment
    slidingExpiresOn String
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    url String
    (string) The (base / API) URL of the service
    environment String
    region String
    domain string
    (string) The domain associated with the service
    host string
    (string) The host of the service
    id string
    orgAdminUsername string
    (string) The IAM OrgAdmin used for authenticating against IAM
    regions string[]
    (string) The list of known regions
    service string
    serviceId string
    (string) The IAM service ID used for authenticating against IAM
    services string[]
    (list(string)) The list of available services in the region/environment
    slidingExpiresOn string
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    url string
    (string) The (base / API) URL of the service
    environment string
    region string
    domain str
    (string) The domain associated with the service
    host str
    (string) The host of the service
    id str
    org_admin_username str
    (string) The IAM OrgAdmin used for authenticating against IAM
    regions Sequence[str]
    (string) The list of known regions
    service str
    service_id str
    (string) The IAM service ID used for authenticating against IAM
    services Sequence[str]
    (list(string)) The list of available services in the region/environment
    sliding_expires_on str
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    url str
    (string) The (base / API) URL of the service
    environment str
    region str
    domain String
    (string) The domain associated with the service
    host String
    (string) The host of the service
    id String
    orgAdminUsername String
    (string) The IAM OrgAdmin used for authenticating against IAM
    regions List<String>
    (string) The list of known regions
    service String
    serviceId String
    (string) The IAM service ID used for authenticating against IAM
    services List<String>
    (list(string)) The list of available services in the region/environment
    slidingExpiresOn String
    (string) A sliding expires on RFC3339 timestamp which can be used to rotate e.g. credentials. The value is the first day of the next quarter calculated from the current wall clock time.
    url String
    (string) The (base / API) URL of the service
    environment String
    region String

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software