akamai.AppSecSelectedHostnames

Scopes: Security configuration

Modifies the list of hostnames protected under by a security configuration.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/selected-hostnames

Example Usage

Basic usage

using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;

return await Deployment.RunAsync(() => 
{
    var configuration = Akamai.GetAppSecConfiguration.Invoke(new()
    {
        Name = "Documentation",
    });

    var appsecselectedhostnames = new Akamai.AppSecSelectedHostnames("appsecselectedhostnames", new()
    {
        ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
        Hostnames = new[]
        {
            "example.com",
        },
        Mode = "APPEND",
    });

});
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v4/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &akamai.LookupAppSecConfigurationArgs{
			Name: pulumi.StringRef("Documentation"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = akamai.NewAppSecSelectedHostnames(ctx, "appsecselectedhostnames", &akamai.AppSecSelectedHostnamesArgs{
			ConfigId: *pulumi.Int(configuration.ConfigId),
			Hostnames: pulumi.StringArray{
				pulumi.String("example.com"),
			},
			Mode: pulumi.String("APPEND"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetAppSecConfigurationArgs;
import com.pulumi.akamai.AppSecSelectedHostnames;
import com.pulumi.akamai.AppSecSelectedHostnamesArgs;
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 configuration = AkamaiFunctions.getAppSecConfiguration(GetAppSecConfigurationArgs.builder()
            .name("Documentation")
            .build());

        var appsecselectedhostnames = new AppSecSelectedHostnames("appsecselectedhostnames", AppSecSelectedHostnamesArgs.builder()        
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .hostnames("example.com")
            .mode("APPEND")
            .build());

    }
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
appsecselectedhostnames = akamai.AppSecSelectedHostnames("appsecselectedhostnames",
    config_id=configuration.config_id,
    hostnames=["example.com"],
    mode="APPEND")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const appsecselectedhostnames = new akamai.AppSecSelectedHostnames("appsecselectedhostnames", {
    configId: configuration.then(configuration => configuration.configId),
    hostnames: ["example.com"],
    mode: "APPEND",
});
resources:
  appsecselectedhostnames:
    type: akamai:AppSecSelectedHostnames
    properties:
      configId: ${configuration.configId}
      hostnames:
        - example.com
      mode: APPEND
variables:
  configuration:
    fn::invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation

Create AppSecSelectedHostnames Resource

new AppSecSelectedHostnames(name: string, args: AppSecSelectedHostnamesArgs, opts?: CustomResourceOptions);
@overload
def AppSecSelectedHostnames(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            config_id: Optional[int] = None,
                            hostnames: Optional[Sequence[str]] = None,
                            mode: Optional[str] = None)
@overload
def AppSecSelectedHostnames(resource_name: str,
                            args: AppSecSelectedHostnamesArgs,
                            opts: Optional[ResourceOptions] = None)
func NewAppSecSelectedHostnames(ctx *Context, name string, args AppSecSelectedHostnamesArgs, opts ...ResourceOption) (*AppSecSelectedHostnames, error)
public AppSecSelectedHostnames(string name, AppSecSelectedHostnamesArgs args, CustomResourceOptions? opts = null)
public AppSecSelectedHostnames(String name, AppSecSelectedHostnamesArgs args)
public AppSecSelectedHostnames(String name, AppSecSelectedHostnamesArgs args, CustomResourceOptions options)
type: akamai:AppSecSelectedHostnames
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppSecSelectedHostnamesArgs
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 AppSecSelectedHostnamesArgs
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 AppSecSelectedHostnamesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecSelectedHostnamesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppSecSelectedHostnamesArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ConfigId int

. Unique identifier of the security configuration associated with the hostnames.

Hostnames List<string>

. JSON array of hostnames to be added or removed from the protected hosts list.

Mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
ConfigId int

. Unique identifier of the security configuration associated with the hostnames.

Hostnames []string

. JSON array of hostnames to be added or removed from the protected hosts list.

Mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId Integer

. Unique identifier of the security configuration associated with the hostnames.

hostnames List<String>

. JSON array of hostnames to be added or removed from the protected hosts list.

mode String

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId number

. Unique identifier of the security configuration associated with the hostnames.

hostnames string[]

. JSON array of hostnames to be added or removed from the protected hosts list.

mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
config_id int

. Unique identifier of the security configuration associated with the hostnames.

hostnames Sequence[str]

. JSON array of hostnames to be added or removed from the protected hosts list.

mode str

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId Number

. Unique identifier of the security configuration associated with the hostnames.

hostnames List<String>

. JSON array of hostnames to be added or removed from the protected hosts list.

mode String

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.

Outputs

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

Get an existing AppSecSelectedHostnames 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?: AppSecSelectedHostnamesState, opts?: CustomResourceOptions): AppSecSelectedHostnames
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        hostnames: Optional[Sequence[str]] = None,
        mode: Optional[str] = None) -> AppSecSelectedHostnames
func GetAppSecSelectedHostnames(ctx *Context, name string, id IDInput, state *AppSecSelectedHostnamesState, opts ...ResourceOption) (*AppSecSelectedHostnames, error)
public static AppSecSelectedHostnames Get(string name, Input<string> id, AppSecSelectedHostnamesState? state, CustomResourceOptions? opts = null)
public static AppSecSelectedHostnames get(String name, Output<String> id, AppSecSelectedHostnamesState 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:
ConfigId int

. Unique identifier of the security configuration associated with the hostnames.

Hostnames List<string>

. JSON array of hostnames to be added or removed from the protected hosts list.

Mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
ConfigId int

. Unique identifier of the security configuration associated with the hostnames.

Hostnames []string

. JSON array of hostnames to be added or removed from the protected hosts list.

Mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId Integer

. Unique identifier of the security configuration associated with the hostnames.

hostnames List<String>

. JSON array of hostnames to be added or removed from the protected hosts list.

mode String

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId number

. Unique identifier of the security configuration associated with the hostnames.

hostnames string[]

. JSON array of hostnames to be added or removed from the protected hosts list.

mode string

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
config_id int

. Unique identifier of the security configuration associated with the hostnames.

hostnames Sequence[str]

. JSON array of hostnames to be added or removed from the protected hosts list.

mode str

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.
configId Number

. Unique identifier of the security configuration associated with the hostnames.

hostnames List<String>

. JSON array of hostnames to be added or removed from the protected hosts list.

mode String

. Indicates how the hostnames array is to be applied. Allowed values are:

  • APPEND. Hosts listed in the hostnames array are added to the current list of selected hostnames.
  • REPLACE. Hosts listed in the hostnames array overwrite the current list of selected hostnames: the “old” hostnames are replaced by the specified set of hostnames.
  • REMOVE, Hosts listed in the hostnames array are removed from the current list of select hostnames.

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.