1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. dns
  5. GtmInstance
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

alicloud.dns.GtmInstance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

    Provides a Alidns Gtm Instance resource.

    For information about Alidns Gtm Instance and how to use it, see What is Gtm Instance.

    NOTE: Available since v1.151.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const domainName = config.get("domainName") || "alicloud-provider.com";
    const default = alicloud.resourcemanager.getResourceGroups({});
    const defaultAlarmContactGroup = new alicloud.cms.AlarmContactGroup("default", {alarmContactGroupName: "tf_example"});
    const defaultGtmInstance = new alicloud.dns.GtmInstance("default", {
        instanceName: "tf_example",
        paymentType: "Subscription",
        period: 1,
        renewalStatus: "ManualRenewal",
        packageEdition: "standard",
        healthCheckTaskCount: 100,
        smsNotificationCount: 1000,
        publicCnameMode: "SYSTEM_ASSIGN",
        ttl: 60,
        cnameType: "PUBLIC",
        resourceGroupId: _default.then(_default => _default.groups?.[0]?.id),
        alertGroups: [defaultAlarmContactGroup.alarmContactGroupName],
        publicUserDomainName: domainName,
        alertConfigs: [{
            smsNotice: true,
            noticeType: "ADDR_ALERT",
            emailNotice: true,
            dingtalkNotice: true,
        }],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    domain_name = config.get("domainName")
    if domain_name is None:
        domain_name = "alicloud-provider.com"
    default = alicloud.resourcemanager.get_resource_groups()
    default_alarm_contact_group = alicloud.cms.AlarmContactGroup("default", alarm_contact_group_name="tf_example")
    default_gtm_instance = alicloud.dns.GtmInstance("default",
        instance_name="tf_example",
        payment_type="Subscription",
        period=1,
        renewal_status="ManualRenewal",
        package_edition="standard",
        health_check_task_count=100,
        sms_notification_count=1000,
        public_cname_mode="SYSTEM_ASSIGN",
        ttl=60,
        cname_type="PUBLIC",
        resource_group_id=default.groups[0].id,
        alert_groups=[default_alarm_contact_group.alarm_contact_group_name],
        public_user_domain_name=domain_name,
        alert_configs=[alicloud.dns.GtmInstanceAlertConfigArgs(
            sms_notice=True,
            notice_type="ADDR_ALERT",
            email_notice=True,
            dingtalk_notice=True,
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cms"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dns"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		domainName := "alicloud-provider.com"
    		if param := cfg.Get("domainName"); param != "" {
    			domainName = param
    		}
    		_default, err := resourcemanager.GetResourceGroups(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		defaultAlarmContactGroup, err := cms.NewAlarmContactGroup(ctx, "default", &cms.AlarmContactGroupArgs{
    			AlarmContactGroupName: pulumi.String("tf_example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = dns.NewGtmInstance(ctx, "default", &dns.GtmInstanceArgs{
    			InstanceName:         pulumi.String("tf_example"),
    			PaymentType:          pulumi.String("Subscription"),
    			Period:               pulumi.Int(1),
    			RenewalStatus:        pulumi.String("ManualRenewal"),
    			PackageEdition:       pulumi.String("standard"),
    			HealthCheckTaskCount: pulumi.Int(100),
    			SmsNotificationCount: pulumi.Int(1000),
    			PublicCnameMode:      pulumi.String("SYSTEM_ASSIGN"),
    			Ttl:                  pulumi.Int(60),
    			CnameType:            pulumi.String("PUBLIC"),
    			ResourceGroupId:      pulumi.String(_default.Groups[0].Id),
    			AlertGroups: pulumi.StringArray{
    				defaultAlarmContactGroup.AlarmContactGroupName,
    			},
    			PublicUserDomainName: pulumi.String(domainName),
    			AlertConfigs: dns.GtmInstanceAlertConfigArray{
    				&dns.GtmInstanceAlertConfigArgs{
    					SmsNotice:      pulumi.Bool(true),
    					NoticeType:     pulumi.String("ADDR_ALERT"),
    					EmailNotice:    pulumi.Bool(true),
    					DingtalkNotice: pulumi.Bool(true),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var domainName = config.Get("domainName") ?? "alicloud-provider.com";
        var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
    
        var defaultAlarmContactGroup = new AliCloud.Cms.AlarmContactGroup("default", new()
        {
            AlarmContactGroupName = "tf_example",
        });
    
        var defaultGtmInstance = new AliCloud.Dns.GtmInstance("default", new()
        {
            InstanceName = "tf_example",
            PaymentType = "Subscription",
            Period = 1,
            RenewalStatus = "ManualRenewal",
            PackageEdition = "standard",
            HealthCheckTaskCount = 100,
            SmsNotificationCount = 1000,
            PublicCnameMode = "SYSTEM_ASSIGN",
            Ttl = 60,
            CnameType = "PUBLIC",
            ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Groups[0]?.Id)),
            AlertGroups = new[]
            {
                defaultAlarmContactGroup.AlarmContactGroupName,
            },
            PublicUserDomainName = domainName,
            AlertConfigs = new[]
            {
                new AliCloud.Dns.Inputs.GtmInstanceAlertConfigArgs
                {
                    SmsNotice = true,
                    NoticeType = "ADDR_ALERT",
                    EmailNotice = true,
                    DingtalkNotice = true,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
    import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
    import com.pulumi.alicloud.cms.AlarmContactGroup;
    import com.pulumi.alicloud.cms.AlarmContactGroupArgs;
    import com.pulumi.alicloud.dns.GtmInstance;
    import com.pulumi.alicloud.dns.GtmInstanceArgs;
    import com.pulumi.alicloud.dns.inputs.GtmInstanceAlertConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var domainName = config.get("domainName").orElse("alicloud-provider.com");
            final var default = ResourcemanagerFunctions.getResourceGroups();
    
            var defaultAlarmContactGroup = new AlarmContactGroup("defaultAlarmContactGroup", AlarmContactGroupArgs.builder()
                .alarmContactGroupName("tf_example")
                .build());
    
            var defaultGtmInstance = new GtmInstance("defaultGtmInstance", GtmInstanceArgs.builder()
                .instanceName("tf_example")
                .paymentType("Subscription")
                .period(1)
                .renewalStatus("ManualRenewal")
                .packageEdition("standard")
                .healthCheckTaskCount(100)
                .smsNotificationCount(1000)
                .publicCnameMode("SYSTEM_ASSIGN")
                .ttl(60)
                .cnameType("PUBLIC")
                .resourceGroupId(default_.groups()[0].id())
                .alertGroups(defaultAlarmContactGroup.alarmContactGroupName())
                .publicUserDomainName(domainName)
                .alertConfigs(GtmInstanceAlertConfigArgs.builder()
                    .smsNotice(true)
                    .noticeType("ADDR_ALERT")
                    .emailNotice(true)
                    .dingtalkNotice(true)
                    .build())
                .build());
    
        }
    }
    
    configuration:
      domainName:
        type: string
        default: alicloud-provider.com
    resources:
      defaultAlarmContactGroup:
        type: alicloud:cms:AlarmContactGroup
        name: default
        properties:
          alarmContactGroupName: tf_example
      defaultGtmInstance:
        type: alicloud:dns:GtmInstance
        name: default
        properties:
          instanceName: tf_example
          paymentType: Subscription
          period: 1
          renewalStatus: ManualRenewal
          packageEdition: standard
          healthCheckTaskCount: 100
          smsNotificationCount: 1000
          publicCnameMode: SYSTEM_ASSIGN
          ttl: 60
          cnameType: PUBLIC
          resourceGroupId: ${default.groups[0].id}
          alertGroups:
            - ${defaultAlarmContactGroup.alarmContactGroupName}
          publicUserDomainName: ${domainName}
          alertConfigs:
            - smsNotice: true
              noticeType: ADDR_ALERT
              emailNotice: true
              dingtalkNotice: true
    variables:
      default:
        fn::invoke:
          Function: alicloud:resourcemanager:getResourceGroups
          Arguments: {}
    

    Create GtmInstance Resource

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

    Constructor syntax

    new GtmInstance(name: string, args: GtmInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def GtmInstance(resource_name: str,
                    args: GtmInstanceArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def GtmInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    package_edition: Optional[str] = None,
                    sms_notification_count: Optional[int] = None,
                    period: Optional[int] = None,
                    payment_type: Optional[str] = None,
                    health_check_task_count: Optional[int] = None,
                    instance_name: Optional[str] = None,
                    public_cname_mode: Optional[str] = None,
                    public_zone_name: Optional[str] = None,
                    force_update: Optional[bool] = None,
                    cname_type: Optional[str] = None,
                    alert_configs: Optional[Sequence[GtmInstanceAlertConfigArgs]] = None,
                    public_rr: Optional[str] = None,
                    public_user_domain_name: Optional[str] = None,
                    lang: Optional[str] = None,
                    renew_period: Optional[int] = None,
                    renewal_status: Optional[str] = None,
                    resource_group_id: Optional[str] = None,
                    alert_groups: Optional[Sequence[str]] = None,
                    strategy_mode: Optional[str] = None,
                    ttl: Optional[int] = None)
    func NewGtmInstance(ctx *Context, name string, args GtmInstanceArgs, opts ...ResourceOption) (*GtmInstance, error)
    public GtmInstance(string name, GtmInstanceArgs args, CustomResourceOptions? opts = null)
    public GtmInstance(String name, GtmInstanceArgs args)
    public GtmInstance(String name, GtmInstanceArgs args, CustomResourceOptions options)
    
    type: alicloud:dns:GtmInstance
    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 GtmInstanceArgs
    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 GtmInstanceArgs
    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 GtmInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GtmInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GtmInstanceArgs
    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 gtmInstanceResource = new AliCloud.Dns.GtmInstance("gtmInstanceResource", new()
    {
        PackageEdition = "string",
        SmsNotificationCount = 0,
        Period = 0,
        PaymentType = "string",
        HealthCheckTaskCount = 0,
        InstanceName = "string",
        PublicCnameMode = "string",
        PublicZoneName = "string",
        ForceUpdate = false,
        CnameType = "string",
        AlertConfigs = new[]
        {
            new AliCloud.Dns.Inputs.GtmInstanceAlertConfigArgs
            {
                DingtalkNotice = false,
                EmailNotice = false,
                NoticeType = "string",
                SmsNotice = false,
            },
        },
        PublicRr = "string",
        PublicUserDomainName = "string",
        Lang = "string",
        RenewPeriod = 0,
        RenewalStatus = "string",
        ResourceGroupId = "string",
        AlertGroups = new[]
        {
            "string",
        },
        StrategyMode = "string",
        Ttl = 0,
    });
    
    example, err := dns.NewGtmInstance(ctx, "gtmInstanceResource", &dns.GtmInstanceArgs{
    	PackageEdition:       pulumi.String("string"),
    	SmsNotificationCount: pulumi.Int(0),
    	Period:               pulumi.Int(0),
    	PaymentType:          pulumi.String("string"),
    	HealthCheckTaskCount: pulumi.Int(0),
    	InstanceName:         pulumi.String("string"),
    	PublicCnameMode:      pulumi.String("string"),
    	PublicZoneName:       pulumi.String("string"),
    	ForceUpdate:          pulumi.Bool(false),
    	CnameType:            pulumi.String("string"),
    	AlertConfigs: dns.GtmInstanceAlertConfigArray{
    		&dns.GtmInstanceAlertConfigArgs{
    			DingtalkNotice: pulumi.Bool(false),
    			EmailNotice:    pulumi.Bool(false),
    			NoticeType:     pulumi.String("string"),
    			SmsNotice:      pulumi.Bool(false),
    		},
    	},
    	PublicRr:             pulumi.String("string"),
    	PublicUserDomainName: pulumi.String("string"),
    	Lang:                 pulumi.String("string"),
    	RenewPeriod:          pulumi.Int(0),
    	RenewalStatus:        pulumi.String("string"),
    	ResourceGroupId:      pulumi.String("string"),
    	AlertGroups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	StrategyMode: pulumi.String("string"),
    	Ttl:          pulumi.Int(0),
    })
    
    var gtmInstanceResource = new GtmInstance("gtmInstanceResource", GtmInstanceArgs.builder()
        .packageEdition("string")
        .smsNotificationCount(0)
        .period(0)
        .paymentType("string")
        .healthCheckTaskCount(0)
        .instanceName("string")
        .publicCnameMode("string")
        .publicZoneName("string")
        .forceUpdate(false)
        .cnameType("string")
        .alertConfigs(GtmInstanceAlertConfigArgs.builder()
            .dingtalkNotice(false)
            .emailNotice(false)
            .noticeType("string")
            .smsNotice(false)
            .build())
        .publicRr("string")
        .publicUserDomainName("string")
        .lang("string")
        .renewPeriod(0)
        .renewalStatus("string")
        .resourceGroupId("string")
        .alertGroups("string")
        .strategyMode("string")
        .ttl(0)
        .build());
    
    gtm_instance_resource = alicloud.dns.GtmInstance("gtmInstanceResource",
        package_edition="string",
        sms_notification_count=0,
        period=0,
        payment_type="string",
        health_check_task_count=0,
        instance_name="string",
        public_cname_mode="string",
        public_zone_name="string",
        force_update=False,
        cname_type="string",
        alert_configs=[alicloud.dns.GtmInstanceAlertConfigArgs(
            dingtalk_notice=False,
            email_notice=False,
            notice_type="string",
            sms_notice=False,
        )],
        public_rr="string",
        public_user_domain_name="string",
        lang="string",
        renew_period=0,
        renewal_status="string",
        resource_group_id="string",
        alert_groups=["string"],
        strategy_mode="string",
        ttl=0)
    
    const gtmInstanceResource = new alicloud.dns.GtmInstance("gtmInstanceResource", {
        packageEdition: "string",
        smsNotificationCount: 0,
        period: 0,
        paymentType: "string",
        healthCheckTaskCount: 0,
        instanceName: "string",
        publicCnameMode: "string",
        publicZoneName: "string",
        forceUpdate: false,
        cnameType: "string",
        alertConfigs: [{
            dingtalkNotice: false,
            emailNotice: false,
            noticeType: "string",
            smsNotice: false,
        }],
        publicRr: "string",
        publicUserDomainName: "string",
        lang: "string",
        renewPeriod: 0,
        renewalStatus: "string",
        resourceGroupId: "string",
        alertGroups: ["string"],
        strategyMode: "string",
        ttl: 0,
    });
    
    type: alicloud:dns:GtmInstance
    properties:
        alertConfigs:
            - dingtalkNotice: false
              emailNotice: false
              noticeType: string
              smsNotice: false
        alertGroups:
            - string
        cnameType: string
        forceUpdate: false
        healthCheckTaskCount: 0
        instanceName: string
        lang: string
        packageEdition: string
        paymentType: string
        period: 0
        publicCnameMode: string
        publicRr: string
        publicUserDomainName: string
        publicZoneName: string
        renewPeriod: 0
        renewalStatus: string
        resourceGroupId: string
        smsNotificationCount: 0
        strategyMode: string
        ttl: 0
    

    GtmInstance 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 GtmInstance resource accepts the following input properties:

    HealthCheckTaskCount int
    The quota of detection tasks.
    InstanceName string
    The name of the instance.
    PackageEdition string
    Paid package version. Valid values: ultimate, standard.
    PaymentType string
    The Payment Type of the resource. Valid value: Subscription.
    Period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    SmsNotificationCount int
    The quota of SMS notifications.
    AlertConfigs List<Pulumi.AliCloud.Dns.Inputs.GtmInstanceAlertConfig>
    The alert notification methods. See alert_config below for details.
    AlertGroups List<string>
    The alert group.
    CnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    ForceUpdate bool
    The force update.
    Lang string
    The lang.
    PublicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    PublicRr string
    The CNAME access domain name.
    PublicUserDomainName string
    The website domain name that the user uses on the Internet.
    PublicZoneName string
    The domain name that is used to access GTM over the Internet.
    RenewPeriod int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    RenewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    ResourceGroupId string
    The ID of the resource group.
    StrategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    Ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    HealthCheckTaskCount int
    The quota of detection tasks.
    InstanceName string
    The name of the instance.
    PackageEdition string
    Paid package version. Valid values: ultimate, standard.
    PaymentType string
    The Payment Type of the resource. Valid value: Subscription.
    Period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    SmsNotificationCount int
    The quota of SMS notifications.
    AlertConfigs []GtmInstanceAlertConfigArgs
    The alert notification methods. See alert_config below for details.
    AlertGroups []string
    The alert group.
    CnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    ForceUpdate bool
    The force update.
    Lang string
    The lang.
    PublicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    PublicRr string
    The CNAME access domain name.
    PublicUserDomainName string
    The website domain name that the user uses on the Internet.
    PublicZoneName string
    The domain name that is used to access GTM over the Internet.
    RenewPeriod int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    RenewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    ResourceGroupId string
    The ID of the resource group.
    StrategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    Ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    healthCheckTaskCount Integer
    The quota of detection tasks.
    instanceName String
    The name of the instance.
    packageEdition String
    Paid package version. Valid values: ultimate, standard.
    paymentType String
    The Payment Type of the resource. Valid value: Subscription.
    period Integer
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    smsNotificationCount Integer
    The quota of SMS notifications.
    alertConfigs List<GtmInstanceAlertConfig>
    The alert notification methods. See alert_config below for details.
    alertGroups List<String>
    The alert group.
    cnameType String
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate Boolean
    The force update.
    lang String
    The lang.
    publicCnameMode String
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr String
    The CNAME access domain name.
    publicUserDomainName String
    The website domain name that the user uses on the Internet.
    publicZoneName String
    The domain name that is used to access GTM over the Internet.
    renewPeriod Integer
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus String
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId String
    The ID of the resource group.
    strategyMode String
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl Integer
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    healthCheckTaskCount number
    The quota of detection tasks.
    instanceName string
    The name of the instance.
    packageEdition string
    Paid package version. Valid values: ultimate, standard.
    paymentType string
    The Payment Type of the resource. Valid value: Subscription.
    period number
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    smsNotificationCount number
    The quota of SMS notifications.
    alertConfigs GtmInstanceAlertConfig[]
    The alert notification methods. See alert_config below for details.
    alertGroups string[]
    The alert group.
    cnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate boolean
    The force update.
    lang string
    The lang.
    publicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr string
    The CNAME access domain name.
    publicUserDomainName string
    The website domain name that the user uses on the Internet.
    publicZoneName string
    The domain name that is used to access GTM over the Internet.
    renewPeriod number
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId string
    The ID of the resource group.
    strategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl number
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    health_check_task_count int
    The quota of detection tasks.
    instance_name str
    The name of the instance.
    package_edition str
    Paid package version. Valid values: ultimate, standard.
    payment_type str
    The Payment Type of the resource. Valid value: Subscription.
    period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    sms_notification_count int
    The quota of SMS notifications.
    alert_configs Sequence[GtmInstanceAlertConfigArgs]
    The alert notification methods. See alert_config below for details.
    alert_groups Sequence[str]
    The alert group.
    cname_type str
    The access type of the CNAME domain name. Valid value: PUBLIC.
    force_update bool
    The force update.
    lang str
    The lang.
    public_cname_mode str
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    public_rr str
    The CNAME access domain name.
    public_user_domain_name str
    The website domain name that the user uses on the Internet.
    public_zone_name str
    The domain name that is used to access GTM over the Internet.
    renew_period int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewal_status str
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resource_group_id str
    The ID of the resource group.
    strategy_mode str
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    healthCheckTaskCount Number
    The quota of detection tasks.
    instanceName String
    The name of the instance.
    packageEdition String
    Paid package version. Valid values: ultimate, standard.
    paymentType String
    The Payment Type of the resource. Valid value: Subscription.
    period Number
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    smsNotificationCount Number
    The quota of SMS notifications.
    alertConfigs List<Property Map>
    The alert notification methods. See alert_config below for details.
    alertGroups List<String>
    The alert group.
    cnameType String
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate Boolean
    The force update.
    lang String
    The lang.
    publicCnameMode String
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr String
    The CNAME access domain name.
    publicUserDomainName String
    The website domain name that the user uses on the Internet.
    publicZoneName String
    The domain name that is used to access GTM over the Internet.
    renewPeriod Number
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus String
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId String
    The ID of the resource group.
    strategyMode String
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl Number
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GtmInstance 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 GtmInstance Resource

    Get an existing GtmInstance 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?: GtmInstanceState, opts?: CustomResourceOptions): GtmInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_configs: Optional[Sequence[GtmInstanceAlertConfigArgs]] = None,
            alert_groups: Optional[Sequence[str]] = None,
            cname_type: Optional[str] = None,
            force_update: Optional[bool] = None,
            health_check_task_count: Optional[int] = None,
            instance_name: Optional[str] = None,
            lang: Optional[str] = None,
            package_edition: Optional[str] = None,
            payment_type: Optional[str] = None,
            period: Optional[int] = None,
            public_cname_mode: Optional[str] = None,
            public_rr: Optional[str] = None,
            public_user_domain_name: Optional[str] = None,
            public_zone_name: Optional[str] = None,
            renew_period: Optional[int] = None,
            renewal_status: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            sms_notification_count: Optional[int] = None,
            strategy_mode: Optional[str] = None,
            ttl: Optional[int] = None) -> GtmInstance
    func GetGtmInstance(ctx *Context, name string, id IDInput, state *GtmInstanceState, opts ...ResourceOption) (*GtmInstance, error)
    public static GtmInstance Get(string name, Input<string> id, GtmInstanceState? state, CustomResourceOptions? opts = null)
    public static GtmInstance get(String name, Output<String> id, GtmInstanceState 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:
    AlertConfigs List<Pulumi.AliCloud.Dns.Inputs.GtmInstanceAlertConfig>
    The alert notification methods. See alert_config below for details.
    AlertGroups List<string>
    The alert group.
    CnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    ForceUpdate bool
    The force update.
    HealthCheckTaskCount int
    The quota of detection tasks.
    InstanceName string
    The name of the instance.
    Lang string
    The lang.
    PackageEdition string
    Paid package version. Valid values: ultimate, standard.
    PaymentType string
    The Payment Type of the resource. Valid value: Subscription.
    Period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    PublicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    PublicRr string
    The CNAME access domain name.
    PublicUserDomainName string
    The website domain name that the user uses on the Internet.
    PublicZoneName string
    The domain name that is used to access GTM over the Internet.
    RenewPeriod int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    RenewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    ResourceGroupId string
    The ID of the resource group.
    SmsNotificationCount int
    The quota of SMS notifications.
    StrategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    Ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    AlertConfigs []GtmInstanceAlertConfigArgs
    The alert notification methods. See alert_config below for details.
    AlertGroups []string
    The alert group.
    CnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    ForceUpdate bool
    The force update.
    HealthCheckTaskCount int
    The quota of detection tasks.
    InstanceName string
    The name of the instance.
    Lang string
    The lang.
    PackageEdition string
    Paid package version. Valid values: ultimate, standard.
    PaymentType string
    The Payment Type of the resource. Valid value: Subscription.
    Period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    PublicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    PublicRr string
    The CNAME access domain name.
    PublicUserDomainName string
    The website domain name that the user uses on the Internet.
    PublicZoneName string
    The domain name that is used to access GTM over the Internet.
    RenewPeriod int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    RenewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    ResourceGroupId string
    The ID of the resource group.
    SmsNotificationCount int
    The quota of SMS notifications.
    StrategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    Ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    alertConfigs List<GtmInstanceAlertConfig>
    The alert notification methods. See alert_config below for details.
    alertGroups List<String>
    The alert group.
    cnameType String
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate Boolean
    The force update.
    healthCheckTaskCount Integer
    The quota of detection tasks.
    instanceName String
    The name of the instance.
    lang String
    The lang.
    packageEdition String
    Paid package version. Valid values: ultimate, standard.
    paymentType String
    The Payment Type of the resource. Valid value: Subscription.
    period Integer
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    publicCnameMode String
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr String
    The CNAME access domain name.
    publicUserDomainName String
    The website domain name that the user uses on the Internet.
    publicZoneName String
    The domain name that is used to access GTM over the Internet.
    renewPeriod Integer
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus String
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId String
    The ID of the resource group.
    smsNotificationCount Integer
    The quota of SMS notifications.
    strategyMode String
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl Integer
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    alertConfigs GtmInstanceAlertConfig[]
    The alert notification methods. See alert_config below for details.
    alertGroups string[]
    The alert group.
    cnameType string
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate boolean
    The force update.
    healthCheckTaskCount number
    The quota of detection tasks.
    instanceName string
    The name of the instance.
    lang string
    The lang.
    packageEdition string
    Paid package version. Valid values: ultimate, standard.
    paymentType string
    The Payment Type of the resource. Valid value: Subscription.
    period number
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    publicCnameMode string
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr string
    The CNAME access domain name.
    publicUserDomainName string
    The website domain name that the user uses on the Internet.
    publicZoneName string
    The domain name that is used to access GTM over the Internet.
    renewPeriod number
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus string
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId string
    The ID of the resource group.
    smsNotificationCount number
    The quota of SMS notifications.
    strategyMode string
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl number
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    alert_configs Sequence[GtmInstanceAlertConfigArgs]
    The alert notification methods. See alert_config below for details.
    alert_groups Sequence[str]
    The alert group.
    cname_type str
    The access type of the CNAME domain name. Valid value: PUBLIC.
    force_update bool
    The force update.
    health_check_task_count int
    The quota of detection tasks.
    instance_name str
    The name of the instance.
    lang str
    The lang.
    package_edition str
    Paid package version. Valid values: ultimate, standard.
    payment_type str
    The Payment Type of the resource. Valid value: Subscription.
    period int
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    public_cname_mode str
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    public_rr str
    The CNAME access domain name.
    public_user_domain_name str
    The website domain name that the user uses on the Internet.
    public_zone_name str
    The domain name that is used to access GTM over the Internet.
    renew_period int
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewal_status str
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resource_group_id str
    The ID of the resource group.
    sms_notification_count int
    The quota of SMS notifications.
    strategy_mode str
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl int
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.
    alertConfigs List<Property Map>
    The alert notification methods. See alert_config below for details.
    alertGroups List<String>
    The alert group.
    cnameType String
    The access type of the CNAME domain name. Valid value: PUBLIC.
    forceUpdate Boolean
    The force update.
    healthCheckTaskCount Number
    The quota of detection tasks.
    instanceName String
    The name of the instance.
    lang String
    The lang.
    packageEdition String
    Paid package version. Valid values: ultimate, standard.
    paymentType String
    The Payment Type of the resource. Valid value: Subscription.
    period Number
    Creating a pre-paid instance, it must be set, the unit is month, please enter an integer multiple of 12 for annually paid products.
    publicCnameMode String
    The Public Network domain name access method. Valid values: CUSTOM, SYSTEM_ASSIGN.
    publicRr String
    The CNAME access domain name.
    publicUserDomainName String
    The website domain name that the user uses on the Internet.
    publicZoneName String
    The domain name that is used to access GTM over the Internet.
    renewPeriod Number
    Automatic renewal period, the unit is month. When setting renewal_status to AutoRenewal, it must be set.
    renewalStatus String
    Automatic renewal status. Valid values: AutoRenewal, ManualRenewal.
    resourceGroupId String
    The ID of the resource group.
    smsNotificationCount Number
    The quota of SMS notifications.
    strategyMode String
    The type of the access policy. Valid values: GEO, LATENCY.
    ttl Number
    The global time to live. Valid values: 60, 120, 300, 600. Unit: second.

    Supporting Types

    GtmInstanceAlertConfig, GtmInstanceAlertConfigArgs

    DingtalkNotice bool
    Whether to configure DingTalk notifications. Valid values: true, false.
    EmailNotice bool
    Whether to configure mail notification. Valid values: true, false.
    NoticeType string
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    SmsNotice bool
    Whether to configure SMS notification. Valid values: true, false.
    DingtalkNotice bool
    Whether to configure DingTalk notifications. Valid values: true, false.
    EmailNotice bool
    Whether to configure mail notification. Valid values: true, false.
    NoticeType string
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    SmsNotice bool
    Whether to configure SMS notification. Valid values: true, false.
    dingtalkNotice Boolean
    Whether to configure DingTalk notifications. Valid values: true, false.
    emailNotice Boolean
    Whether to configure mail notification. Valid values: true, false.
    noticeType String
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    smsNotice Boolean
    Whether to configure SMS notification. Valid values: true, false.
    dingtalkNotice boolean
    Whether to configure DingTalk notifications. Valid values: true, false.
    emailNotice boolean
    Whether to configure mail notification. Valid values: true, false.
    noticeType string
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    smsNotice boolean
    Whether to configure SMS notification. Valid values: true, false.
    dingtalk_notice bool
    Whether to configure DingTalk notifications. Valid values: true, false.
    email_notice bool
    Whether to configure mail notification. Valid values: true, false.
    notice_type str
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    sms_notice bool
    Whether to configure SMS notification. Valid values: true, false.
    dingtalkNotice Boolean
    Whether to configure DingTalk notifications. Valid values: true, false.
    emailNotice Boolean
    Whether to configure mail notification. Valid values: true, false.
    noticeType String
    The Alarm Event Type.

    • ADDR_ALERT: Address not available.
    • ADDR_RESUME: Address Recovery available.
    • ADDR_POOL_GROUP_UNAVAILABLE: Address pool collection not available.
    • ADDR_POOL_GROUP_AVAILABLE: Address pool collection recovery available.
    • ACCESS_STRATEGY_POOL_GROUP_SWITCH: Primary/standby address pool switch.
    • MONITOR_NODE_IP_CHANGE: Monitoring node IP address changes.
    smsNotice Boolean
    Whether to configure SMS notification. Valid values: true, false.

    Import

    Alidns Gtm Instance can be imported using the id, e.g.

    $ pulumi import alicloud:dns/gtmInstance:GtmInstance example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi