Akamai

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Wednesday, Apr 6, 2022 by Pulumi

EdgeHostName

Deprecated:

akamai.properties.EdgeHostName has been deprecated in favor of akamai.EdgeHostName

The akamai.EdgeHostName resource lets you configure a secure edge hostname. Your edge hostname determines how requests for your site, app, or content are mapped to Akamai edge servers.

An edge hostname is the CNAME target you use when directing your end user traffic to Akamai. Each hostname assigned to a property has a corresponding edge hostname.

Akamai supports three types of edge hostnames, depending on the level of security you need for your traffic: Standard TLS, Enhanced TLS, and Shared Certificate. When entering the edge_hostname attribute, you need to include a specific domain suffix for your edge hostname type:

Edge hostname typeDomain suffix
Enhanced TLSedgekey.net
Standard TLSedgesuite.net
Shared Certakamaized.net

For example, if you use Standard TLS and have www.example.com as a hostname, your edge hostname would be www.example.com.edgesuite.net. If you wanted to use Enhanced TLS with the same hostname, your edge hostname would be www.example.com.edgekey.net. See the Property Manager API (PAPI) for more information.

Attributes reference

This resource returns this attribute:

  • ip_behavior - Returns the IP protocol the hostname will use, either IPV4 for version 4, IPV6_PERFORMANCEfor version 6, orIPV6_COMPLIANCE` for both.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var provider_demo = new Akamai.EdgeHostName("provider-demo", new Akamai.EdgeHostNameArgs
        {
            ContractId = "ctr_1-AB123",
            EdgeHostname = "www.example.org.edgesuite.net",
            GroupId = "grp_123",
            ProductId = "prd_Object_Delivery",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.NewEdgeHostName(ctx, "provider-demo", &akamai.EdgeHostNameArgs{
			ContractId:   pulumi.String("ctr_1-AB123"),
			EdgeHostname: pulumi.String("www.example.org.edgesuite.net"),
			GroupId:      pulumi.String("grp_123"),
			ProductId:    pulumi.String("prd_Object_Delivery"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_akamai as akamai

provider_demo = akamai.EdgeHostName("provider-demo",
    contract_id="ctr_1-AB123",
    edge_hostname="www.example.org.edgesuite.net",
    group_id="grp_123",
    product_id="prd_Object_Delivery")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const provider_demo = new akamai.EdgeHostName("provider-demo", {
    contractId: "ctr_1-AB123",
    edgeHostname: "www.example.org.edgesuite.net",
    groupId: "grp_123",
    productId: "prd_Object_Delivery",
});

Coming soon!

Create a EdgeHostName Resource

new EdgeHostName(name: string, args: EdgeHostNameArgs, opts?: CustomResourceOptions);
@overload
def EdgeHostName(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 certificate: Optional[int] = None,
                 contract: Optional[str] = None,
                 contract_id: Optional[str] = None,
                 edge_hostname: Optional[str] = None,
                 group: Optional[str] = None,
                 group_id: Optional[str] = None,
                 ip_behavior: Optional[str] = None,
                 product: Optional[str] = None,
                 product_id: Optional[str] = None,
                 use_cases: Optional[str] = None)
@overload
def EdgeHostName(resource_name: str,
                 args: EdgeHostNameArgs,
                 opts: Optional[ResourceOptions] = None)
func NewEdgeHostName(ctx *Context, name string, args EdgeHostNameArgs, opts ...ResourceOption) (*EdgeHostName, error)
public EdgeHostName(string name, EdgeHostNameArgs args, CustomResourceOptions? opts = null)
public EdgeHostName(String name, EdgeHostNameArgs args)
public EdgeHostName(String name, EdgeHostNameArgs args, CustomResourceOptions options)
type: akamai:properties:EdgeHostName
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EdgeHostNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EdgeHostNameArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EdgeHostNameArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EdgeHostNameArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EdgeHostNameArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EdgeHostName Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EdgeHostName resource accepts the following input properties:

EdgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

IpBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

Certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

Group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

GroupId string

- (Required) A group's unique ID, including the grp_ prefix.

Product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

ProductId string
UseCases string

A JSON encoded list of use cases

EdgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

IpBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

Certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

Group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

GroupId string

- (Required) A group's unique ID, including the grp_ prefix.

Product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

ProductId string
UseCases string

A JSON encoded list of use cases

edgeHostname String

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

ipBehavior String

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

certificate Integer

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

group String

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId String

- (Required) A group's unique ID, including the grp_ prefix.

product String

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId String
useCases String

A JSON encoded list of use cases

edgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

ipBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

certificate number

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId string

- (Required) A group's unique ID, including the grp_ prefix.

product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId string
useCases string

A JSON encoded list of use cases

edge_hostname str

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

ip_behavior str

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract str

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contract_id str

- (Required) A contract's unique ID, including the ctr_ prefix.

group str

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

group_id str

- (Required) A group's unique ID, including the grp_ prefix.

product str

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

product_id str
use_cases str

A JSON encoded list of use cases

edgeHostname String

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

ipBehavior String

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

certificate Number

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

group String

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId String

- (Required) A group's unique ID, including the grp_ prefix.

product String

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId String
useCases String

A JSON encoded list of use cases

Outputs

All input properties are implicitly available as output properties. Additionally, the EdgeHostName resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing EdgeHostName Resource

Get an existing EdgeHostName resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EdgeHostNameState, opts?: CustomResourceOptions): EdgeHostName
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate: Optional[int] = None,
        contract: Optional[str] = None,
        contract_id: Optional[str] = None,
        edge_hostname: Optional[str] = None,
        group: Optional[str] = None,
        group_id: Optional[str] = None,
        ip_behavior: Optional[str] = None,
        product: Optional[str] = None,
        product_id: Optional[str] = None,
        use_cases: Optional[str] = None) -> EdgeHostName
func GetEdgeHostName(ctx *Context, name string, id IDInput, state *EdgeHostNameState, opts ...ResourceOption) (*EdgeHostName, error)
public static EdgeHostName Get(string name, Input<string> id, EdgeHostNameState? state, CustomResourceOptions? opts = null)
public static EdgeHostName get(String name, Output<String> id, EdgeHostNameState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

EdgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

Group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

GroupId string

- (Required) A group's unique ID, including the grp_ prefix.

IpBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

Product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

ProductId string
UseCases string

A JSON encoded list of use cases

Certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

Contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

ContractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

EdgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

Group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

GroupId string

- (Required) A group's unique ID, including the grp_ prefix.

IpBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

Product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

ProductId string
UseCases string

A JSON encoded list of use cases

certificate Integer

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

edgeHostname String

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

group String

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId String

- (Required) A group's unique ID, including the grp_ prefix.

ipBehavior String

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

product String

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId String
useCases String

A JSON encoded list of use cases

certificate number

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract string

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId string

- (Required) A contract's unique ID, including the ctr_ prefix.

edgeHostname string

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

group string

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId string

- (Required) A group's unique ID, including the grp_ prefix.

ipBehavior string

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

product string

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId string
useCases string

A JSON encoded list of use cases

certificate int

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract str

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contract_id str

- (Required) A contract's unique ID, including the ctr_ prefix.

edge_hostname str

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

group str

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

group_id str

- (Required) A group's unique ID, including the grp_ prefix.

ip_behavior str

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

product str

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

product_id str
use_cases str

A JSON encoded list of use cases

certificate Number

Required only when creating an Enhanced TLS edge hostname. This argument sets the certificate enrollment ID. Edge hostnames for Enhanced TLS end in edgekey.net. You can retrieve this ID from the Certificate Provisioning Service CLI .

contract String

Replaced by contract_id. Maintained for legacy purposes.

Deprecated:

The setting "contract" has been deprecated.

contractId String

- (Required) A contract's unique ID, including the ctr_ prefix.

edgeHostname String

One or more edge hostnames. The number of edge hostnames must be less than or equal to the number of public hostnames.

group String

Replaced by group_id. Maintained for legacy purposes.

Deprecated:

The setting "group" has been deprecated.

groupId String

- (Required) A group's unique ID, including the grp_ prefix.

ipBehavior String

Which version of the IP protocol to use: IPV4 for version 4 only, IPV6_PERFORMANCE for version 6 only, or IPV6_COMPLIANCE for both 4 and 6.

product String

Replaced by product_id. Maintained for legacy purposes.

Deprecated:

The setting "product" has been deprecated.

productId String
useCases String

A JSON encoded list of use cases

Import

Basic Usagehcl resource “akamai_edge_hostname” “example” {

(resource arguments)

} You can import Akamai edge hostnames using a comma-delimited string of edge hostname, contract ID, and group ID. You have to enter the values in this order:

edge_hostname, contract_id, group_id For example

 $ pulumi import akamai:properties/edgeHostName:EdgeHostName example ehn_123,ctr_1-AB123,grp_123

Package Details

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

This Pulumi package is based on the akamai Terraform Provider.