Akamai v8.1.0, Apr 11 25

Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi

akamai.EdgeHostName

Explore with Pulumi AI

Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi

Create EdgeHostName Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EdgeHostName(name: string, args: EdgeHostNameArgs, opts?: CustomResourceOptions);

@overload
def EdgeHostName(resource_name: str,
                 args: EdgeHostNameArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def EdgeHostName(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 contract_id: Optional[str] = None,
                 edge_hostname: Optional[str] = None,
                 group_id: Optional[str] = None,
                 ip_behavior: Optional[str] = None,
                 certificate: Optional[int] = None,
                 product_id: Optional[str] = None,
                 status_update_emails: Optional[Sequence[str]] = None,
                 timeouts: Optional[EdgeHostNameTimeoutsArgs] = None,
                 ttl: Optional[int] = None,
                 use_cases: Optional[str] = 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:EdgeHostName
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var edgeHostNameResource = new Akamai.EdgeHostName("edgeHostNameResource", new()
{
    ContractId = "string",
    EdgeHostname = "string",
    GroupId = "string",
    IpBehavior = "string",
    Certificate = 0,
    ProductId = "string",
    StatusUpdateEmails = new[]
    {
        "string",
    },
    Timeouts = new Akamai.Inputs.EdgeHostNameTimeoutsArgs
    {
        Default = "string",
    },
    Ttl = 0,
    UseCases = "string",
});

example, err := akamai.NewEdgeHostName(ctx, "edgeHostNameResource", &akamai.EdgeHostNameArgs{
	ContractId:   pulumi.String("string"),
	EdgeHostname: pulumi.String("string"),
	GroupId:      pulumi.String("string"),
	IpBehavior:   pulumi.String("string"),
	Certificate:  pulumi.Int(0),
	ProductId:    pulumi.String("string"),
	StatusUpdateEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &akamai.EdgeHostNameTimeoutsArgs{
		Default: pulumi.String("string"),
	},
	Ttl:      pulumi.Int(0),
	UseCases: pulumi.String("string"),
})

var edgeHostNameResource = new EdgeHostName("edgeHostNameResource", EdgeHostNameArgs.builder()
    .contractId("string")
    .edgeHostname("string")
    .groupId("string")
    .ipBehavior("string")
    .certificate(0)
    .productId("string")
    .statusUpdateEmails("string")
    .timeouts(EdgeHostNameTimeoutsArgs.builder()
        .default_("string")
        .build())
    .ttl(0)
    .useCases("string")
    .build());

edge_host_name_resource = akamai.EdgeHostName("edgeHostNameResource",
    contract_id="string",
    edge_hostname="string",
    group_id="string",
    ip_behavior="string",
    certificate=0,
    product_id="string",
    status_update_emails=["string"],
    timeouts={
        "default": "string",
    },
    ttl=0,
    use_cases="string")

const edgeHostNameResource = new akamai.EdgeHostName("edgeHostNameResource", {
    contractId: "string",
    edgeHostname: "string",
    groupId: "string",
    ipBehavior: "string",
    certificate: 0,
    productId: "string",
    statusUpdateEmails: ["string"],
    timeouts: {
        "default": "string",
    },
    ttl: 0,
    useCases: "string",
});

type: akamai:EdgeHostName
properties:
    certificate: 0
    contractId: string
    edgeHostname: string
    groupId: string
    ipBehavior: string
    productId: string
    statusUpdateEmails:
        - string
    timeouts:
        default: string
    ttl: 0
    useCases: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EdgeHostName resource accepts the following input properties:

ContractId string
EdgeHostname string
GroupId string
IpBehavior string
Certificate int
ProductId string
StatusUpdateEmails List<string>: Email address that should receive updates on the IP behavior update request.
Timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
Ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
UseCases string: A JSON encoded list of use cases

ContractId string
EdgeHostname string
GroupId string
IpBehavior string
Certificate int
ProductId string
StatusUpdateEmails []string: Email address that should receive updates on the IP behavior update request.
Timeouts EdgeHostNameTimeoutsArgs: Enables to set timeout for processing
Ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
UseCases string: A JSON encoded list of use cases

contractId String
edgeHostname String
groupId String
ipBehavior String
certificate Integer
productId String
statusUpdateEmails List<String>: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
ttl Integer: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
useCases String: A JSON encoded list of use cases

contractId string
edgeHostname string
groupId string
ipBehavior string
certificate number
productId string
statusUpdateEmails string[]: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
ttl number: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
useCases string: A JSON encoded list of use cases

contract_id str
edge_hostname str
group_id str
ip_behavior str
certificate int
product_id str
status_update_emails Sequence[str]: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeoutsArgs: Enables to set timeout for processing
ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
use_cases str: A JSON encoded list of use cases

contractId String
edgeHostname String
groupId String
ipBehavior String
certificate Number
productId String
statusUpdateEmails List<String>: Email address that should receive updates on the IP behavior update request.
timeouts Property Map: Enables to set timeout for processing
ttl Number: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
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 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_id: Optional[str] = None,
        edge_hostname: Optional[str] = None,
        group_id: Optional[str] = None,
        ip_behavior: Optional[str] = None,
        product_id: Optional[str] = None,
        status_update_emails: Optional[Sequence[str]] = None,
        timeouts: Optional[EdgeHostNameTimeoutsArgs] = None,
        ttl: Optional[int] = 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)

resources:  _:    type: akamai:EdgeHostName    get:      id: ${id}

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
ContractId string
EdgeHostname string
GroupId string
IpBehavior string
ProductId string
StatusUpdateEmails List<string>: Email address that should receive updates on the IP behavior update request.
Timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
Ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
UseCases string: A JSON encoded list of use cases

Certificate int
ContractId string
EdgeHostname string
GroupId string
IpBehavior string
ProductId string
StatusUpdateEmails []string: Email address that should receive updates on the IP behavior update request.
Timeouts EdgeHostNameTimeoutsArgs: Enables to set timeout for processing
Ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
UseCases string: A JSON encoded list of use cases

certificate Integer
contractId String
edgeHostname String
groupId String
ipBehavior String
productId String
statusUpdateEmails List<String>: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
ttl Integer: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
useCases String: A JSON encoded list of use cases

certificate number
contractId string
edgeHostname string
groupId string
ipBehavior string
productId string
statusUpdateEmails string[]: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeouts: Enables to set timeout for processing
ttl number: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
useCases string: A JSON encoded list of use cases

certificate int
contract_id str
edge_hostname str
group_id str
ip_behavior str
product_id str
status_update_emails Sequence[str]: Email address that should receive updates on the IP behavior update request.
timeouts EdgeHostNameTimeoutsArgs: Enables to set timeout for processing
ttl int: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
use_cases str: A JSON encoded list of use cases

certificate Number
contractId String
edgeHostname String
groupId String
ipBehavior String
productId String
statusUpdateEmails List<String>: Email address that should receive updates on the IP behavior update request.
timeouts Property Map: Enables to set timeout for processing
ttl Number: The time to live, or number of seconds to keep an edge hostname assigned to a map or target. If not provided default value for product is used.
useCases String: A JSON encoded list of use cases