Akamai

Pulumi Official
Package maintained by Pulumi
v3.0.0 published on Monday, Jul 25, 2022 by Pulumi

getCloudletsApplicationLoadBalancer

Use the akamai.CloudletsApplicationLoadBalancer data source to list details about the Application Load Balancer configuration with a specified policy version, or latest if not specified.

Basic usage

This example returns the load balancing configuration details based on the origin ID and optionally, a version:

import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const example = pulumi.output(akamai.getCloudletsApplicationLoadBalancer({
    originId: "alb_test_1",
    version: 1,
}));
import pulumi
import pulumi_akamai as akamai

example = akamai.get_cloudlets_application_load_balancer(origin_id="alb_test_1",
    version=1)
using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Akamai.GetCloudletsApplicationLoadBalancer.InvokeAsync(new Akamai.GetCloudletsApplicationLoadBalancerArgs
        {
            OriginId = "alb_test_1",
            Version = 1,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v3/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.LookupCloudletsApplicationLoadBalancer(ctx, &GetCloudletsApplicationLoadBalancerArgs{
			OriginId: "alb_test_1",
			Version:  pulumi.IntRef(1),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetCloudletsApplicationLoadBalancerArgs;
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 example = AkamaiFunctions.getCloudletsApplicationLoadBalancer(GetCloudletsApplicationLoadBalancerArgs.builder()
            .originId("alb_test_1")
            .version(1)
            .build());

    }
}
variables:
  example:
    Fn::Invoke:
      Function: akamai:getCloudletsApplicationLoadBalancer
      Arguments:
        originId: alb_test_1
        version: 1

Attributes reference

This data source returns these attributes:

  • description - The description of the load balancing configuration.
  • type - The type of Conditional Origin. APPLICATION_LOAD_BALANCER is the only supported value.
  • balancing_type - The type of load balancing being performed, either WEIGHTED or PERFORMANCE.
  • created_by - The name of the user who created this load balancing configuration.
  • created_date - The date, in ISO 8601 format, when this load balancing configuration was created.
  • deleted - Whether the Conditional Origin version has been deleted. If false, you can use this version again.
  • immutable - Whether you can edit the load balancing version. The default setting for this member is false. It automatically becomes true when the load balancing version is activated for the first time.
  • last_modified_by - The user who last modified the load balancing configuration.
  • last_modified_date - The date, in ISO 8601 format, when the initial load balancing configuration was last modified.
  • warnings - A list of warnings that occured during the activation of the load balancing configuration.
  • data_centers - Specifies the Conditional Origins being used as data centers for an Application Load Balancer implementation. Only Conditional Origins with an origin type of CUSTOMER or NETSTORAGE can be used as data centers in an Application Load Balancer configuration.
    • city - The city in which the data center is located.
    • cloud_server_host_header_override - Whether the cloud server host header is overridden.
    • cloud_service - Whether this datacenter is a cloud service.
    • continent - The code of the continent on which the data center is located. See Continent Codes for a list of valid codes.
    • country - The country in which the data center is located. See Country Codes for a list of valid codes.
    • hostname - The name of the host that can be used as a Conditional Origin. This should match the hostname value defined for this datacenter in Property Manager.
    • latitude - The latitude value for the data center. This member supports six decimal places of precision.
    • liveness_hosts - A list of the origin servers used to poll the data centers in an Application Load Balancer configuration. These servers support basic HTTP polling.
    • longitude - The longitude value for the data center. This member supports six decimal places of precision.
    • origin_id - The ID of an origin that represents the data center. The Conditional Origin, which is defined in Property Manager, must have an origin type of either CUSTOMER or NET_STORAGE set in the origin behavior. See property rules for more information.
    • percent - The percent of traffic that is sent to the data center. The total for all data centers must equal 100%.
    • state_or_province - The state, province, or region where the data center is located.
  • liveness_settings - Specifies the health of each load balanced data center defined in the data center list.
    • host_header - The Host header for the liveness HTTP request.
    • additional_headers - Maps additional case-insensitive HTTP header names included to the liveness testing requests.
    • interval - The frequency of liveness tests. Defaults to 60 seconds, minimum is 10 seconds.
    • path - The path to the test object used for liveness testing. The function of the test object is to help determine whether the data center is functioning.
    • peer_certificate_verification - Whether to validate the origin certificate for an HTTPS request.
    • port - The port for the test object. The default port is 80, which is standard for HTTP. Enter 443 if you are using HTTPS.
    • protocol - The protocol or scheme for the database, either HTTP or HTTPS.
    • request_string - The request used for TCP and TCPS tests.
    • response_string - The response used for TCP and TCPS tests.
    • status_3xx_failure - If true, marks the liveness test as failed when the request returns a 3xx (redirection) status code.
    • status_4xx_failure - If true, marks the liveness test as failed when the request returns a 4xx (client error) status code.
    • status_5xx_failure - If true, marks the liveness test as failed when the request returns a 5xx (server error) status code.
    • timeout - The number of seconds the system waits before failing the liveness test.

Using getCloudletsApplicationLoadBalancer

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 getCloudletsApplicationLoadBalancer(args: GetCloudletsApplicationLoadBalancerArgs, opts?: InvokeOptions): Promise<GetCloudletsApplicationLoadBalancerResult>
function getCloudletsApplicationLoadBalancerOutput(args: GetCloudletsApplicationLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetCloudletsApplicationLoadBalancerResult>
def get_cloudlets_application_load_balancer(origin_id: Optional[str] = None,
                                            version: Optional[int] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetCloudletsApplicationLoadBalancerResult
def get_cloudlets_application_load_balancer_output(origin_id: Optional[pulumi.Input[str]] = None,
                                            version: Optional[pulumi.Input[int]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetCloudletsApplicationLoadBalancerResult]
func LookupCloudletsApplicationLoadBalancer(ctx *Context, args *LookupCloudletsApplicationLoadBalancerArgs, opts ...InvokeOption) (*LookupCloudletsApplicationLoadBalancerResult, error)
func LookupCloudletsApplicationLoadBalancerOutput(ctx *Context, args *LookupCloudletsApplicationLoadBalancerOutputArgs, opts ...InvokeOption) LookupCloudletsApplicationLoadBalancerResultOutput

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

public static class GetCloudletsApplicationLoadBalancer 
{
    public static Task<GetCloudletsApplicationLoadBalancerResult> InvokeAsync(GetCloudletsApplicationLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudletsApplicationLoadBalancerResult> Invoke(GetCloudletsApplicationLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCloudletsApplicationLoadBalancerResult> getCloudletsApplicationLoadBalancer(GetCloudletsApplicationLoadBalancerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: akamai:index/getCloudletsApplicationLoadBalancer:getCloudletsApplicationLoadBalancer
  Arguments:
    # Arguments dictionary

The following arguments are supported:

OriginId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

Version int

- (Optional) The version number of the load balancing configuration.

OriginId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

Version int

- (Optional) The version number of the load balancing configuration.

originId String

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

version Integer

- (Optional) The version number of the load balancing configuration.

originId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

version number

- (Optional) The version number of the load balancing configuration.

origin_id str

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

version int

- (Optional) The version number of the load balancing configuration.

originId String

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

version Number

- (Optional) The version number of the load balancing configuration.

getCloudletsApplicationLoadBalancer Result

The following output properties are available:

balancingType String
createdBy String
createdDate String
dataCenters List<Property Map>
deleted Boolean
description String
id String

The provider-assigned unique ID for this managed resource.

immutable Boolean
lastModifiedBy String
lastModifiedDate String
livenessSettings List<Property Map>
originId String
type String
warnings String
version Number

Supporting Types

GetCloudletsApplicationLoadBalancerDataCenter

City string
CloudServerHostHeaderOverride bool
CloudService bool
Continent string
Country string
Hostname string
Latitude double
LivenessHosts List<string>
Longitude double
OriginId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

Percent double
StateOrProvince string
City string
CloudServerHostHeaderOverride bool
CloudService bool
Continent string
Country string
Hostname string
Latitude float64
LivenessHosts []string
Longitude float64
OriginId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

Percent float64
StateOrProvince string
city String
cloudServerHostHeaderOverride Boolean
cloudService Boolean
continent String
country String
hostname String
latitude Double
livenessHosts List<String>
longitude Double
originId String

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

percent Double
stateOrProvince String
city string
cloudServerHostHeaderOverride boolean
cloudService boolean
continent string
country string
hostname string
latitude number
livenessHosts string[]
longitude number
originId string

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

percent number
stateOrProvince string
city str
cloud_server_host_header_override bool
cloud_service bool
continent str
country str
hostname str
latitude float
liveness_hosts Sequence[str]
longitude float
origin_id str

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

percent float
state_or_province str
city String
cloudServerHostHeaderOverride Boolean
cloudService Boolean
continent String
country String
hostname String
latitude Number
livenessHosts List<String>
longitude Number
originId String

- (Required) A unique identifier for the Conditional Origin that supports the load balancing configuration. The Conditional Origin type must be set to APPLICATION_LOAD_BALANCER in the origin behavior. See property rules for more information.

percent Number
stateOrProvince String

GetCloudletsApplicationLoadBalancerLivenessSetting

additionalHeaders Map<String,String>
hostHeader String
interval Integer
path String
peerCertificateVerification Boolean
port Integer
protocol String
requestString String
responseString String
status3xxFailure Boolean
status4xxFailure Boolean
status5xxFailure Boolean
timeout Double
additionalHeaders {[key: string]: string}
hostHeader string
interval number
path string
peerCertificateVerification boolean
port number
protocol string
requestString string
responseString string
status3xxFailure boolean
status4xxFailure boolean
status5xxFailure boolean
timeout number

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.