azurermAppServiceCustomHostnameBinding
Manages a Hostname Binding within an App Service (or Function App).
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
import * as random from "./.gen/providers/random";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm, random.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "some-resource-group",
}
);
const randomIdServer = new random.id.Id(this, "server", {
byte_length: 8,
keepers: [
{
azi_id: 1,
},
],
});
const azurermAppServicePlanExample = new azurerm.appServicePlan.AppServicePlan(
this,
"example_2",
{
location: azurermResourceGroupExample.location,
name: "some-app-service-plan",
resource_group_name: azurermResourceGroupExample.name,
sku: [
{
size: "S1",
tier: "Standard",
},
],
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermAppServicePlanExample.overrideLogicalId("example");
const azurermAppServiceExample = new azurerm.appService.AppService(
this,
"example_3",
{
app_service_plan_id: azurermAppServicePlanExample.id,
location: azurermResourceGroupExample.location,
name: randomIdServer.hex,
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermAppServiceExample.overrideLogicalId("example");
const azurermAppServiceCustomHostnameBindingExample =
new azurerm.appServiceCustomHostnameBinding.AppServiceCustomHostnameBinding(
this,
"example_4",
{
app_service_name: azurermAppServiceExample.name,
hostname: "www.mywebsite.com",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermAppServiceCustomHostnameBindingExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
hostname- (Required) Specifies the Custom Hostname to use for the App Service, examplewwwExampleCom. Changing this forces a new resource to be created.
\~> NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
-
appServiceName- (Required) The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created. -
resourceGroupName- (Required) The name of the resource group in which the App Service exists. Changing this forces a new resource to be created. -
sslState- (Optional) The SSL type. Possible values areipBasedEnabledandsniEnabled. Changing this forces a new resource to be created. -
thumbprint- (Optional) The SSL certificate thumbprint. Changing this forces a new resource to be created.
-> NOTE: thumbprint must be specified when sslState is set.
Attributes Reference
The following attributes are exported:
-
id- The ID of the App Service Custom Hostname Binding -
virtualIp- The virtual IP address assigned to the hostname if IP based SSL is enabled.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the App Service Custom Hostname Binding.update- (Defaults to 30 minutes) Used when updating the App Service Custom Hostname Binding.read- (Defaults to 5 minutes) Used when retrieving the App Service Custom Hostname Binding.delete- (Defaults to 30 minutes) Used when deleting the App Service Custom Hostname Binding.
Import
App Service Custom Hostname Bindings can be imported using the resourceId, e.g.