Docs Home
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
akamai.EdgeHostName
Explore with Pulumi AI
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
This property is required. string - The unique name of the resource.
- args
This property is required. EdgeHostNameArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. EdgeHostNameArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EdgeHostNameArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Contract
Id This property is required. string - Edge
Hostname stringThis property is required. 
Changes to this property will trigger replacement. - Group
Id This property is required. string - Ip
Behavior This property is required. string - Certificate
- Product
Id string - Status
Update List<string>Emails - Email address that should receive updates on the IP behavior update request.
- Timeouts
Edge
Host Name Timeouts - 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 - A JSON encoded list of use cases
- Contract
Id This property is required. string - Edge
Hostname stringThis property is required. Changes to this property will trigger replacement. - Group
Id This property is required. string - Ip
Behavior This property is required. string - Certificate
- Product
Id string - Status
Update []stringEmails - Email address that should receive updates on the IP behavior update request.
- Timeouts
Edge
Host Name Timeouts Args - 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 - A JSON encoded list of use cases
- contract
Id This property is required. String - edge
Hostname StringThis property is required. Changes to this property will trigger replacement. - group
Id This property is required. String - ip
Behavior This property is required. String - certificate
- product
Id String - status
Update List<String>Emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts - 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.
- use
Cases - A JSON encoded list of use cases
- contract
Id This property is required. string - edge
Hostname stringThis property is required. Changes to this property will trigger replacement. - group
Id This property is required. string - ip
Behavior This property is required. string - certificate
- product
Id string - status
Update string[]Emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts - 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.
- use
Cases - A JSON encoded list of use cases
- contract_
id This property is required. str - edge_
hostname strThis property is required. Changes to this property will trigger replacement. - group_
id This property is required. str - ip_
behavior This property is required. str - certificate
- product_
id str - status_
update_ Sequence[str]emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts Args - 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 - A JSON encoded list of use cases
- contract
Id This property is required. String - edge
Hostname StringThis property is required. Changes to this property will trigger replacement. - group
Id This property is required. String - ip
Behavior This property is required. String - certificate
- product
Id String - status
Update List<String>Emails - 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.
- use
Cases - 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) -> EdgeHostNamefunc 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
- Contract
Id string - Edge
Hostname - Group
Id string - Ip
Behavior string - Product
Id string - Status
Update List<string>Emails - Email address that should receive updates on the IP behavior update request.
- Timeouts
Edge
Host Name Timeouts - 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 - A JSON encoded list of use cases
- Certificate
- Contract
Id string - Edge
Hostname - Group
Id string - Ip
Behavior string - Product
Id string - Status
Update []stringEmails - Email address that should receive updates on the IP behavior update request.
- Timeouts
Edge
Host Name Timeouts Args - 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 - A JSON encoded list of use cases
- certificate
- contract
Id String - edge
Hostname - group
Id String - ip
Behavior String - product
Id String - status
Update List<String>Emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts - 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.
- use
Cases - A JSON encoded list of use cases
- certificate
- contract
Id string - edge
Hostname - group
Id string - ip
Behavior string - product
Id string - status
Update string[]Emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts - 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.
- use
Cases - A JSON encoded list of use cases
- certificate
- contract_
id str - edge_
hostname - group_
id str - ip_
behavior str - product_
id str - status_
update_ Sequence[str]emails - Email address that should receive updates on the IP behavior update request.
- timeouts
Edge
Host Name Timeouts Args - 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 - A JSON encoded list of use cases
- certificate
- contract
Id String - edge
Hostname - group
Id String - ip
Behavior String - product
Id String - status
Update List<String>Emails - 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.
- use
Cases - A JSON encoded list of use cases
Supporting Types
EdgeHostNameTimeouts, EdgeHostNameTimeoutsArgs
, EdgeHostNameTimeoutsArgs
- Default string
- Default string
- default_ String
- default string
- default str
- default String
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
akamaiTerraform Provider.