Skip to content

feat(teo): [126079710] add new resource #3454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/3454.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:new-resource
tencentcloud_teo_customize_error_page
```
1 change: 1 addition & 0 deletions tencentcloud/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -1892,6 +1892,7 @@ func Provider() *schema.Provider {
"tencentcloud_teo_bind_security_template": teo.ResourceTencentCloudTeoBindSecurityTemplate(),
"tencentcloud_teo_plan": teo.ResourceTencentCloudTeoPlan(),
"tencentcloud_teo_content_identifier": teo.ResourceTencentCloudTeoContentIdentifier(),
"tencentcloud_teo_customize_error_page": teo.ResourceTencentCloudTeoCustomizeErrorPage(),
"tencentcloud_tcm_mesh": tcm.ResourceTencentCloudTcmMesh(),
"tencentcloud_tcm_cluster_attachment": tcm.ResourceTencentCloudTcmClusterAttachment(),
"tencentcloud_tcm_prometheus_attachment": tcm.ResourceTencentCloudTcmPrometheusAttachment(),
Expand Down
1 change: 1 addition & 0 deletions tencentcloud/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -1514,6 +1514,7 @@ tencentcloud_teo_security_policy_config
tencentcloud_teo_dns_record
tencentcloud_teo_bind_security_template
tencentcloud_teo_content_identifier
tencentcloud_teo_customize_error_page

TencentCloud ServiceMesh(TCM)
Data Source
Expand Down
286 changes: 286 additions & 0 deletions tencentcloud/services/teo/resource_tc_teo_customize_error_page.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,286 @@
package teo

import (
"context"
"fmt"
"log"
"strings"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
teov20220901 "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/teo/v20220901"

tccommon "github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/common"
"github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/internal/helper"
)

func ResourceTencentCloudTeoCustomizeErrorPage() *schema.Resource {
return &schema.Resource{
Create: resourceTencentCloudTeoCustomizeErrorPageCreate,
Read: resourceTencentCloudTeoCustomizeErrorPageRead,
Update: resourceTencentCloudTeoCustomizeErrorPageUpdate,
Delete: resourceTencentCloudTeoCustomizeErrorPageDelete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
},
Schema: map[string]*schema.Schema{
"zone_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: "Zone ID.",
},

"name": {
Type: schema.TypeString,
Required: true,
Description: "Custom error page name. The name must be 2-30 characters long.",
},

"content_type": {
Type: schema.TypeString,
Required: true,
Description: "Custom error page type, with values:<li>text/html; </li><li>application/json;</li><li>text/plain;</li><li>text/xml.</li>.",
},

"description": {
Type: schema.TypeString,
Optional: true,
Description: "Custom error page description, not exceeding 60 characters.",
},

"content": {
Type: schema.TypeString,
Optional: true,
Description: "Custom error page content, not exceeding 2 KB.",
},

// computed
"page_id": {
Type: schema.TypeString,
Computed: true,
Description: "Page ID.",
},
},
}
}

func resourceTencentCloudTeoCustomizeErrorPageCreate(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_teo_customize_error_page.create")()
defer tccommon.InconsistentCheck(d, meta)()

var (
logId = tccommon.GetLogId(tccommon.ContextNil)
ctx = tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)
request = teov20220901.NewCreateCustomizeErrorPageRequest()
response = teov20220901.NewCreateCustomizeErrorPageResponse()
zoneId string
pageId string
)

if v, ok := d.GetOk("zone_id"); ok {
request.ZoneId = helper.String(v.(string))
zoneId = v.(string)
}

if v, ok := d.GetOk("name"); ok {
request.Name = helper.String(v.(string))
}

if v, ok := d.GetOk("content_type"); ok {
request.ContentType = helper.String(v.(string))
}

if v, ok := d.GetOk("description"); ok {
request.Description = helper.String(v.(string))
}

if v, ok := d.GetOk("content"); ok {
request.Content = helper.String(v.(string))
}

reqErr := resource.Retry(tccommon.WriteRetryTimeout, func() *resource.RetryError {
result, e := meta.(tccommon.ProviderMeta).GetAPIV3Conn().UseTeoV20220901Client().CreateCustomizeErrorPageWithContext(ctx, request)
if e != nil {
return tccommon.RetryError(e)
} else {
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), result.ToJsonString())
}

if result == nil || result.Response == nil {
return resource.NonRetryableError(fmt.Errorf("Create teo customize error page failed, Response is nil."))
}

response = result
return nil
})

if reqErr != nil {
log.Printf("[CRITAL]%s create teo customize error page failed, reason:%+v", logId, reqErr)
return reqErr
}

if response.Response.PageId == nil {
return fmt.Errorf("PageId is nil.")
}

pageId = *response.Response.PageId
d.SetId(strings.Join([]string{zoneId, pageId}, tccommon.FILED_SP))
return resourceTencentCloudTeoCustomizeErrorPageRead(d, meta)
}

func resourceTencentCloudTeoCustomizeErrorPageRead(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_teo_customize_error_page.read")()
defer tccommon.InconsistentCheck(d, meta)()

var (
logId = tccommon.GetLogId(tccommon.ContextNil)
ctx = tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)
service = TeoService{client: meta.(tccommon.ProviderMeta).GetAPIV3Conn()}
)

idSplit := strings.Split(d.Id(), tccommon.FILED_SP)
if len(idSplit) != 2 {
return fmt.Errorf("id is broken,%s", d.Id())
}

zoneId := idSplit[0]
pageId := idSplit[1]

respData, err := service.DescribeTeoCustomizeErrorPageById(ctx, zoneId, pageId)
if err != nil {
return err
}

if respData == nil {
log.Printf("[WARN]%s resource `teo_customize_error_page` [%s] not found, please check if it has been deleted.\n", logId, d.Id())
d.SetId("")
return nil
}

_ = d.Set("zone_id", zoneId)
_ = d.Set("page_id", pageId)

if respData.Name != nil {
_ = d.Set("name", respData.Name)
}

if respData.ContentType != nil {
_ = d.Set("content_type", respData.ContentType)
}

if respData.Description != nil {
_ = d.Set("description", respData.Description)
}

if respData.Content != nil {
_ = d.Set("content", respData.Content)
}

return nil
}

func resourceTencentCloudTeoCustomizeErrorPageUpdate(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_teo_customize_error_page.update")()
defer tccommon.InconsistentCheck(d, meta)()

var (
logId = tccommon.GetLogId(tccommon.ContextNil)
ctx = tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)
)

idSplit := strings.Split(d.Id(), tccommon.FILED_SP)
if len(idSplit) != 2 {
return fmt.Errorf("id is broken,%s", d.Id())
}

zoneId := idSplit[0]
pageId := idSplit[1]

needChange := false
mutableArgs := []string{"name", "description", "content_type", "content"}
for _, v := range mutableArgs {
if d.HasChange(v) {
needChange = true
break
}
}

if needChange {
request := teov20220901.NewModifyCustomErrorPageRequest()
if v, ok := d.GetOk("name"); ok {
request.Name = helper.String(v.(string))
}

if v, ok := d.GetOk("description"); ok {
request.Description = helper.String(v.(string))
}

if v, ok := d.GetOk("content_type"); ok {
request.ContentType = helper.String(v.(string))
}

if v, ok := d.GetOk("content"); ok {
request.Content = helper.String(v.(string))
}

request.ZoneId = &zoneId
request.PageId = &pageId
reqErr := resource.Retry(tccommon.WriteRetryTimeout, func() *resource.RetryError {
result, e := meta.(tccommon.ProviderMeta).GetAPIV3Conn().UseTeoV20220901Client().ModifyCustomErrorPageWithContext(ctx, request)
if e != nil {
return tccommon.RetryError(e)
} else {
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), result.ToJsonString())
}

return nil
})

if reqErr != nil {
log.Printf("[CRITAL]%s update teo customize error page failed, reason:%+v", logId, reqErr)
return reqErr
}
}

return resourceTencentCloudTeoCustomizeErrorPageRead(d, meta)
}

func resourceTencentCloudTeoCustomizeErrorPageDelete(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_teo_customize_error_page.delete")()
defer tccommon.InconsistentCheck(d, meta)()

var (
logId = tccommon.GetLogId(tccommon.ContextNil)
ctx = tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)
request = teov20220901.NewDeleteCustomErrorPageRequest()
)

idSplit := strings.Split(d.Id(), tccommon.FILED_SP)
if len(idSplit) != 2 {
return fmt.Errorf("id is broken,%s", d.Id())
}

zoneId := idSplit[0]
pageId := idSplit[1]

request.ZoneId = &zoneId
request.PageId = &pageId
reqErr := resource.Retry(tccommon.WriteRetryTimeout, func() *resource.RetryError {
result, e := meta.(tccommon.ProviderMeta).GetAPIV3Conn().UseTeoV20220901Client().DeleteCustomErrorPageWithContext(ctx, request)
if e != nil {
return tccommon.RetryError(e)
} else {
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), result.ToJsonString())
}

return nil
})

if reqErr != nil {
log.Printf("[CRITAL]%s delete teo customize error page failed, reason:%+v", logId, reqErr)
return reqErr
}

return nil
}
78 changes: 78 additions & 0 deletions tencentcloud/services/teo/resource_tc_teo_customize_error_page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
Provides a resource to create a TEO customize error page

Example Usage

If content_type is application/json

```hcl
resource "tencentcloud_teo_customize_error_page" "example" {
zone_id = "zone-3edjdliiw3he"
name = "tf-example"
content_type = "application/json"
description = "description."
content = jsonencode({
"key" : "value",
})
}
```

If content_type is text/html

```hcl
resource "tencentcloud_teo_customize_error_page" "example" {
zone_id = "zone-3edjdliiw3he"
name = "tf-example"
content_type = "text/html"
description = "description."
content = <<-EOF
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Error Page</title>
</head>
<body>
customize error page
</body>
</html>
EOF
}
```

If content_type is text/plain

```hcl
resource "tencentcloud_teo_customize_error_page" "example" {
zone_id = "zone-3edjdliiw3he"
name = "tf-example"
content_type = "text/plain"
description = "description."
content = "customize error page"
}
```

If content_type is text/xml

```hcl
resource "tencentcloud_teo_customize_error_page" "example" {
zone_id = "zone-3edjdliiw3he"
name = "tf-example"
content_type = "text/xml"
description = "description."
content = <<-EOF
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/css" href="#internalStyle"?>
<error-page>
<message>customize error page</message>
</error-page>
EOF
}
```

Import

TEO customize error page can be imported using the id, e.g.

```
terraform import tencentcloud_teo_customize_error_page.example zone-3edjdliiw3he#p-3egexy9b4426
```
Loading
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy