1. Packages
  2. Packages
  3. Akamai
  4. API Docs
  5. getEdgeHostname
Viewing docs for Akamai v11.2.0
published on Thursday, May 14, 2026 by Pulumi
akamai logo
Viewing docs for Akamai v11.2.0
published on Thursday, May 14, 2026 by Pulumi

    Using getEdgeHostname

    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 getEdgeHostname(args: GetEdgeHostnameArgs, opts?: InvokeOptions): Promise<GetEdgeHostnameResult>
    function getEdgeHostnameOutput(args: GetEdgeHostnameOutputArgs, opts?: InvokeOptions): Output<GetEdgeHostnameResult>
    def get_edge_hostname(contract_id: Optional[str] = None,
                          group_id: Optional[str] = None,
                          id: Optional[str] = None,
                          options: Optional[Sequence[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetEdgeHostnameResult
    def get_edge_hostname_output(contract_id: pulumi.Input[Optional[str]] = None,
                          group_id: pulumi.Input[Optional[str]] = None,
                          id: pulumi.Input[Optional[str]] = None,
                          options: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetEdgeHostnameResult]
    func GetEdgeHostname(ctx *Context, args *GetEdgeHostnameArgs, opts ...InvokeOption) (*GetEdgeHostnameResult, error)
    func GetEdgeHostnameOutput(ctx *Context, args *GetEdgeHostnameOutputArgs, opts ...InvokeOption) GetEdgeHostnameResultOutput

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

    public static class GetEdgeHostname 
    {
        public static Task<GetEdgeHostnameResult> InvokeAsync(GetEdgeHostnameArgs args, InvokeOptions? opts = null)
        public static Output<GetEdgeHostnameResult> Invoke(GetEdgeHostnameInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEdgeHostnameResult> getEdgeHostname(GetEdgeHostnameArgs args, InvokeOptions options)
    public static Output<GetEdgeHostnameResult> getEdgeHostname(GetEdgeHostnameArgs args, InvokeOptions options)
    
    fn::invoke:
      function: akamai:index/getEdgeHostname:getEdgeHostname
      arguments:
        # arguments dictionary
    data "akamai_getedgehostname" "name" {
        # arguments
    }

    The following arguments are supported:

    ContractId string
    GroupId string
    Id string
    Options List<string>
    ContractId string
    GroupId string
    Id string
    Options []string
    contract_id string
    group_id string
    id string
    options list(string)
    contractId String
    groupId String
    id String
    options List<String>
    contractId string
    groupId string
    id string
    options string[]
    contract_id str
    group_id str
    id str
    options Sequence[str]
    contractId String
    groupId String
    id String
    options List<String>

    getEdgeHostname Result

    The following output properties are available:

    account_id string
    contract_id string
    edge_hostname object
    group_id string
    id string
    options list(string)
    accountId String
    contractId String
    edgeHostname Property Map
    groupId String
    id String
    options List<String>

    Supporting Types

    GetEdgeHostnameEdgeHostname

    DomainPrefix string
    The origin domain portion of the edge hostname.
    DomainSuffix string
    The Akamai-specific portion of the edge hostname.
    EdgeHostnameDomain string
    The full edge domain name formed from the domainPrefix and domainSuffix.
    EdgeHostnameId string
    The edge hostname's unique identifier.
    HttpsServiceBinding string
    HTTPS service binding of the edge hostname.
    IpVersionBehaviour string
    IP version behavior of the edge hostname.
    ProductId string
    The product you created the edge hostname for.
    Secure bool
    Whether to use the edge hostname with SSL.
    Status string
    Status of the edge hostname.
    UseCases List<GetEdgeHostnameEdgeHostnameUseCase>
    Available use cases for edge hostnames assigned to the product.
    DomainPrefix string
    The origin domain portion of the edge hostname.
    DomainSuffix string
    The Akamai-specific portion of the edge hostname.
    EdgeHostnameDomain string
    The full edge domain name formed from the domainPrefix and domainSuffix.
    EdgeHostnameId string
    The edge hostname's unique identifier.
    HttpsServiceBinding string
    HTTPS service binding of the edge hostname.
    IpVersionBehaviour string
    IP version behavior of the edge hostname.
    ProductId string
    The product you created the edge hostname for.
    Secure bool
    Whether to use the edge hostname with SSL.
    Status string
    Status of the edge hostname.
    UseCases []GetEdgeHostnameEdgeHostnameUseCase
    Available use cases for edge hostnames assigned to the product.
    domain_prefix string
    The origin domain portion of the edge hostname.
    domain_suffix string
    The Akamai-specific portion of the edge hostname.
    edge_hostname_domain string
    The full edge domain name formed from the domainPrefix and domainSuffix.
    edge_hostname_id string
    The edge hostname's unique identifier.
    https_service_binding string
    HTTPS service binding of the edge hostname.
    ip_version_behaviour string
    IP version behavior of the edge hostname.
    product_id string
    The product you created the edge hostname for.
    secure bool
    Whether to use the edge hostname with SSL.
    status string
    Status of the edge hostname.
    use_cases list(object)
    Available use cases for edge hostnames assigned to the product.
    domainPrefix String
    The origin domain portion of the edge hostname.
    domainSuffix String
    The Akamai-specific portion of the edge hostname.
    edgeHostnameDomain String
    The full edge domain name formed from the domainPrefix and domainSuffix.
    edgeHostnameId String
    The edge hostname's unique identifier.
    httpsServiceBinding String
    HTTPS service binding of the edge hostname.
    ipVersionBehaviour String
    IP version behavior of the edge hostname.
    productId String
    The product you created the edge hostname for.
    secure Boolean
    Whether to use the edge hostname with SSL.
    status String
    Status of the edge hostname.
    useCases List<GetEdgeHostnameEdgeHostnameUseCase>
    Available use cases for edge hostnames assigned to the product.
    domainPrefix string
    The origin domain portion of the edge hostname.
    domainSuffix string
    The Akamai-specific portion of the edge hostname.
    edgeHostnameDomain string
    The full edge domain name formed from the domainPrefix and domainSuffix.
    edgeHostnameId string
    The edge hostname's unique identifier.
    httpsServiceBinding string
    HTTPS service binding of the edge hostname.
    ipVersionBehaviour string
    IP version behavior of the edge hostname.
    productId string
    The product you created the edge hostname for.
    secure boolean
    Whether to use the edge hostname with SSL.
    status string
    Status of the edge hostname.
    useCases GetEdgeHostnameEdgeHostnameUseCase[]
    Available use cases for edge hostnames assigned to the product.
    domain_prefix str
    The origin domain portion of the edge hostname.
    domain_suffix str
    The Akamai-specific portion of the edge hostname.
    edge_hostname_domain str
    The full edge domain name formed from the domainPrefix and domainSuffix.
    edge_hostname_id str
    The edge hostname's unique identifier.
    https_service_binding str
    HTTPS service binding of the edge hostname.
    ip_version_behaviour str
    IP version behavior of the edge hostname.
    product_id str
    The product you created the edge hostname for.
    secure bool
    Whether to use the edge hostname with SSL.
    status str
    Status of the edge hostname.
    use_cases Sequence[GetEdgeHostnameEdgeHostnameUseCase]
    Available use cases for edge hostnames assigned to the product.
    domainPrefix String
    The origin domain portion of the edge hostname.
    domainSuffix String
    The Akamai-specific portion of the edge hostname.
    edgeHostnameDomain String
    The full edge domain name formed from the domainPrefix and domainSuffix.
    edgeHostnameId String
    The edge hostname's unique identifier.
    httpsServiceBinding String
    HTTPS service binding of the edge hostname.
    ipVersionBehaviour String
    IP version behavior of the edge hostname.
    productId String
    The product you created the edge hostname for.
    secure Boolean
    Whether to use the edge hostname with SSL.
    status String
    Status of the edge hostname.
    useCases List<Property Map>
    Available use cases for edge hostnames assigned to the product.

    GetEdgeHostnameEdgeHostnameUseCase

    Option string
    Specifies one of the available options available in the response object.
    Type string
    Identifies the type of network over which traffic deploys.
    UseCase string
    Identifies each use case.
    Option string
    Specifies one of the available options available in the response object.
    Type string
    Identifies the type of network over which traffic deploys.
    UseCase string
    Identifies each use case.
    option string
    Specifies one of the available options available in the response object.
    type string
    Identifies the type of network over which traffic deploys.
    use_case string
    Identifies each use case.
    option String
    Specifies one of the available options available in the response object.
    type String
    Identifies the type of network over which traffic deploys.
    useCase String
    Identifies each use case.
    option string
    Specifies one of the available options available in the response object.
    type string
    Identifies the type of network over which traffic deploys.
    useCase string
    Identifies each use case.
    option str
    Specifies one of the available options available in the response object.
    type str
    Identifies the type of network over which traffic deploys.
    use_case str
    Identifies each use case.
    option String
    Specifies one of the available options available in the response object.
    type String
    Identifies the type of network over which traffic deploys.
    useCase String
    Identifies each use case.

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Viewing docs for Akamai v11.2.0
    published on Thursday, May 14, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.