Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gcore Provider
  3. API Docs
  4. WaapDomain
gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
g-core/terraform-provider-gcore

gcore.WaapDomain

Explore with Pulumi AI

gcore logo
gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
g-core/terraform-provider-gcore

    Represent WAAP domain

    Create WaapDomain Resource

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

    Constructor syntax

    new WaapDomain(name: string, args?: WaapDomainArgs, opts?: CustomResourceOptions);
    @overload
def WaapDomain(resource_name: str,
               args: Optional[WaapDomainArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def WaapDomain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_discovery_settings: Optional[WaapDomainApiDiscoverySettingsArgs] = None,
               name: Optional[str] = None,
               settings: Optional[WaapDomainSettingsArgs] = None,
               status: Optional[str] = None,
               waap_domain_id: Optional[str] = None)
    func NewWaapDomain(ctx *Context, name string, args *WaapDomainArgs, opts ...ResourceOption) (*WaapDomain, error)
    public WaapDomain(string name, WaapDomainArgs? args = null, CustomResourceOptions? opts = null)
    public WaapDomain(String name, WaapDomainArgs args)
public WaapDomain(String name, WaapDomainArgs args, CustomResourceOptions options)

    type: gcore:WaapDomain
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 WaapDomainArgs
    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 WaapDomainArgs
    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 WaapDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WaapDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WaapDomainArgs
    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 waapDomainResource = new Gcore.WaapDomain("waapDomainResource", new()
{
    ApiDiscoverySettings = new Gcore.Inputs.WaapDomainApiDiscoverySettingsArgs
    {
        DescriptionFileLocation = "string",
        DescriptionFileScanEnabled = false,
        DescriptionFileScanIntervalHours = 0,
        TrafficScanEnabled = false,
        TrafficScanIntervalHours = 0,
    },
    Name = "string",
    Settings = new Gcore.Inputs.WaapDomainSettingsArgs
    {
        Api = new Gcore.Inputs.WaapDomainSettingsApiArgs
        {
            ApiUrls = new[]
            {
                "string",
            },
        },
        Ddos = new Gcore.Inputs.WaapDomainSettingsDdosArgs
        {
            BurstThreshold = 0,
            GlobalThreshold = 0,
        },
    },
    Status = "string",
    WaapDomainId = "string",
});

    example, err := gcore.NewWaapDomain(ctx, "waapDomainResource", &gcore.WaapDomainArgs{
	ApiDiscoverySettings: &gcore.WaapDomainApiDiscoverySettingsArgs{
		DescriptionFileLocation:          pulumi.String("string"),
		DescriptionFileScanEnabled:       pulumi.Bool(false),
		DescriptionFileScanIntervalHours: pulumi.Float64(0),
		TrafficScanEnabled:               pulumi.Bool(false),
		TrafficScanIntervalHours:         pulumi.Float64(0),
	},
	Name: pulumi.String("string"),
	Settings: &gcore.WaapDomainSettingsArgs{
		Api: &gcore.WaapDomainSettingsApiArgs{
			ApiUrls: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Ddos: &gcore.WaapDomainSettingsDdosArgs{
			BurstThreshold:  pulumi.Float64(0),
			GlobalThreshold: pulumi.Float64(0),
		},
	},
	Status:       pulumi.String("string"),
	WaapDomainId: pulumi.String("string"),
})

    var waapDomainResource = new WaapDomain("waapDomainResource", WaapDomainArgs.builder()
    .apiDiscoverySettings(WaapDomainApiDiscoverySettingsArgs.builder()
        .descriptionFileLocation("string")
        .descriptionFileScanEnabled(false)
        .descriptionFileScanIntervalHours(0.0)
        .trafficScanEnabled(false)
        .trafficScanIntervalHours(0.0)
        .build())
    .name("string")
    .settings(WaapDomainSettingsArgs.builder()
        .api(WaapDomainSettingsApiArgs.builder()
            .apiUrls("string")
            .build())
        .ddos(WaapDomainSettingsDdosArgs.builder()
            .burstThreshold(0.0)
            .globalThreshold(0.0)
            .build())
        .build())
    .status("string")
    .waapDomainId("string")
    .build());

    waap_domain_resource = gcore.WaapDomain("waapDomainResource",
    api_discovery_settings={
        "description_file_location": "string",
        "description_file_scan_enabled": False,
        "description_file_scan_interval_hours": 0,
        "traffic_scan_enabled": False,
        "traffic_scan_interval_hours": 0,
    },
    name="string",
    settings={
        "api": {
            "api_urls": ["string"],
        },
        "ddos": {
            "burst_threshold": 0,
            "global_threshold": 0,
        },
    },
    status="string",
    waap_domain_id="string")

    const waapDomainResource = new gcore.WaapDomain("waapDomainResource", {
    apiDiscoverySettings: {
        descriptionFileLocation: "string",
        descriptionFileScanEnabled: false,
        descriptionFileScanIntervalHours: 0,
        trafficScanEnabled: false,
        trafficScanIntervalHours: 0,
    },
    name: "string",
    settings: {
        api: {
            apiUrls: ["string"],
        },
        ddos: {
            burstThreshold: 0,
            globalThreshold: 0,
        },
    },
    status: "string",
    waapDomainId: "string",
});

    type: gcore:WaapDomain
properties:
    apiDiscoverySettings:
        descriptionFileLocation: string
        descriptionFileScanEnabled: false
        descriptionFileScanIntervalHours: 0
        trafficScanEnabled: false
        trafficScanIntervalHours: 0
    name: string
    settings:
        api:
            apiUrls:
                - string
        ddos:
            burstThreshold: 0
            globalThreshold: 0
    status: string
    waapDomainId: string

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

    ApiDiscoverySettings WaapDomainApiDiscoverySettings
    Name string
    Name of the domain.
    Settings WaapDomainSettings
    Status string
    Status of the domain. It must be one of these values {active, monitor}.
    WaapDomainId string
    The ID of this resource.
    ApiDiscoverySettings WaapDomainApiDiscoverySettingsArgs
    Name string
    Name of the domain.
    Settings WaapDomainSettingsArgs
    Status string
    Status of the domain. It must be one of these values {active, monitor}.
    WaapDomainId string
    The ID of this resource.
    apiDiscoverySettings WaapDomainApiDiscoverySettings
    name String
    Name of the domain.
    settings WaapDomainSettings
    status String
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId String
    The ID of this resource.
    apiDiscoverySettings WaapDomainApiDiscoverySettings
    name string
    Name of the domain.
    settings WaapDomainSettings
    status string
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId string
    The ID of this resource.
    api_discovery_settings WaapDomainApiDiscoverySettingsArgs
    name str
    Name of the domain.
    settings WaapDomainSettingsArgs
    status str
    Status of the domain. It must be one of these values {active, monitor}.
    waap_domain_id str
    The ID of this resource.
    apiDiscoverySettings Property Map
    name String
    Name of the domain.
    settings Property Map
    status String
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId String
    The ID of this resource.

    Outputs

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

    Get an existing WaapDomain 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?: WaapDomainState, opts?: CustomResourceOptions): WaapDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_discovery_settings: Optional[WaapDomainApiDiscoverySettingsArgs] = None,
        name: Optional[str] = None,
        settings: Optional[WaapDomainSettingsArgs] = None,
        status: Optional[str] = None,
        waap_domain_id: Optional[str] = None) -> WaapDomain
    func GetWaapDomain(ctx *Context, name string, id IDInput, state *WaapDomainState, opts ...ResourceOption) (*WaapDomain, error)
    public static WaapDomain Get(string name, Input<string> id, WaapDomainState? state, CustomResourceOptions? opts = null)
    public static WaapDomain get(String name, Output<String> id, WaapDomainState state, CustomResourceOptions options)
    resources:  _:    type: gcore:WaapDomain    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:
    ApiDiscoverySettings WaapDomainApiDiscoverySettings
    Name string
    Name of the domain.
    Settings WaapDomainSettings
    Status string
    Status of the domain. It must be one of these values {active, monitor}.
    WaapDomainId string
    The ID of this resource.
    ApiDiscoverySettings WaapDomainApiDiscoverySettingsArgs
    Name string
    Name of the domain.
    Settings WaapDomainSettingsArgs
    Status string
    Status of the domain. It must be one of these values {active, monitor}.
    WaapDomainId string
    The ID of this resource.
    apiDiscoverySettings WaapDomainApiDiscoverySettings
    name String
    Name of the domain.
    settings WaapDomainSettings
    status String
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId String
    The ID of this resource.
    apiDiscoverySettings WaapDomainApiDiscoverySettings
    name string
    Name of the domain.
    settings WaapDomainSettings
    status string
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId string
    The ID of this resource.
    api_discovery_settings WaapDomainApiDiscoverySettingsArgs
    name str
    Name of the domain.
    settings WaapDomainSettingsArgs
    status str
    Status of the domain. It must be one of these values {active, monitor}.
    waap_domain_id str
    The ID of this resource.
    apiDiscoverySettings Property Map
    name String
    Name of the domain.
    settings Property Map
    status String
    Status of the domain. It must be one of these values {active, monitor}.
    waapDomainId String
    The ID of this resource.

    Supporting Types

    WaapDomainApiDiscoverySettings, WaapDomainApiDiscoverySettingsArgs

    DescriptionFileLocation string
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    DescriptionFileScanEnabled bool
    Indicates if periodic scan of the description file is enabled.
    DescriptionFileScanIntervalHours double
    The interval in hours for scanning the description file.
    TrafficScanEnabled bool
    Indicates if traffic scan is enabled.
    TrafficScanIntervalHours double
    The interval in hours for scanning the traffic.
    DescriptionFileLocation string
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    DescriptionFileScanEnabled bool
    Indicates if periodic scan of the description file is enabled.
    DescriptionFileScanIntervalHours float64
    The interval in hours for scanning the description file.
    TrafficScanEnabled bool
    Indicates if traffic scan is enabled.
    TrafficScanIntervalHours float64
    The interval in hours for scanning the traffic.
    descriptionFileLocation String
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    descriptionFileScanEnabled Boolean
    Indicates if periodic scan of the description file is enabled.
    descriptionFileScanIntervalHours Double
    The interval in hours for scanning the description file.
    trafficScanEnabled Boolean
    Indicates if traffic scan is enabled.
    trafficScanIntervalHours Double
    The interval in hours for scanning the traffic.
    descriptionFileLocation string
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    descriptionFileScanEnabled boolean
    Indicates if periodic scan of the description file is enabled.
    descriptionFileScanIntervalHours number
    The interval in hours for scanning the description file.
    trafficScanEnabled boolean
    Indicates if traffic scan is enabled.
    trafficScanIntervalHours number
    The interval in hours for scanning the traffic.
    description_file_location str
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    description_file_scan_enabled bool
    Indicates if periodic scan of the description file is enabled.
    description_file_scan_interval_hours float
    The interval in hours for scanning the description file.
    traffic_scan_enabled bool
    Indicates if traffic scan is enabled.
    traffic_scan_interval_hours float
    The interval in hours for scanning the traffic.
    descriptionFileLocation String
    The URL of the API description file. This will be periodically scanned if description_file_scan_enabled is enabled. Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2, 3, or 3.1.
    descriptionFileScanEnabled Boolean
    Indicates if periodic scan of the description file is enabled.
    descriptionFileScanIntervalHours Number
    The interval in hours for scanning the description file.
    trafficScanEnabled Boolean
    Indicates if traffic scan is enabled.
    trafficScanIntervalHours Number
    The interval in hours for scanning the traffic.

    WaapDomainSettings, WaapDomainSettingsArgs

    WaapDomainSettingsApi, WaapDomainSettingsApiArgs

    ApiUrls List<string>
    List of API URL patterns.
    ApiUrls []string
    List of API URL patterns.
    apiUrls List<String>
    List of API URL patterns.
    apiUrls string[]
    List of API URL patterns.
    api_urls Sequence[str]
    List of API URL patterns.
    apiUrls List<String>
    List of API URL patterns.

    WaapDomainSettingsDdos, WaapDomainSettingsDdosArgs

    BurstThreshold double
    Burst threshold for DDoS protection.
    GlobalThreshold double
    Global threshold for DDoS protection.
    BurstThreshold float64
    Burst threshold for DDoS protection.
    GlobalThreshold float64
    Global threshold for DDoS protection.
    burstThreshold Double
    Burst threshold for DDoS protection.
    globalThreshold Double
    Global threshold for DDoS protection.
    burstThreshold number
    Burst threshold for DDoS protection.
    globalThreshold number
    Global threshold for DDoS protection.
    burst_threshold float
    Burst threshold for DDoS protection.
    global_threshold float
    Global threshold for DDoS protection.
    burstThreshold Number
    Burst threshold for DDoS protection.
    globalThreshold Number
    Global threshold for DDoS protection.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.24.1 published on Wednesday, Jun 4, 2025 by g-core
    g-core/terraform-provider-gcore