Akamai

v3.1.1 published on Tuesday, Nov 1, 2022 by Pulumi

EdgeKv

The akamai.EdgeKv resource lets you control EdgeKV database functions outside EdgeWorkers JavaScript code. Refer to the EdgeKV documentation for more information.

Attributes reference

There are no supported arguments for this resource.

Example Usage

Basic usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var testStaging = new Akamai.EdgeKv("testStaging", new Akamai.EdgeKvArgs
        {
            GeoLocation = "US",
            GroupId = 4284,
            InitialDatas = 
            {
                new Akamai.Inputs.EdgeKvInitialDataArgs
                {
                    Group = "translations",
                    Key = "lang",
                    Value = "English",
                },
            },
            NamespaceName = "Marketing",
            Network = "staging",
            RetentionInSeconds = 15724800,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.NewEdgeKv(ctx, "testStaging", &akamai.EdgeKvArgs{
			GeoLocation: pulumi.String("US"),
			GroupId:     pulumi.Int(4284),
			InitialDatas: EdgeKvInitialDataArray{
				&EdgeKvInitialDataArgs{
					Group: pulumi.String("translations"),
					Key:   pulumi.String("lang"),
					Value: pulumi.String("English"),
				},
			},
			NamespaceName:      pulumi.String("Marketing"),
			Network:            pulumi.String("staging"),
			RetentionInSeconds: pulumi.Int(15724800),
		})
		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.EdgeKv;
import com.pulumi.akamai.EdgeKvArgs;
import com.pulumi.akamai.inputs.EdgeKvInitialDataArgs;
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) {
        var testStaging = new EdgeKv("testStaging", EdgeKvArgs.builder()        
            .geoLocation("US")
            .groupId(4284)
            .initialDatas(EdgeKvInitialDataArgs.builder()
                .group("translations")
                .key("lang")
                .value("English")
                .build())
            .namespaceName("Marketing")
            .network("staging")
            .retentionInSeconds(15724800)
            .build());

    }
}

import pulumi
import pulumi_akamai as akamai

test_staging = akamai.EdgeKv("testStaging",
    geo_location="US",
    group_id=4284,
    initial_datas=[akamai.EdgeKvInitialDataArgs(
        group="translations",
        key="lang",
        value="English",
    )],
    namespace_name="Marketing",
    network="staging",
    retention_in_seconds=15724800)

import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const testStaging = new akamai.EdgeKv("test_staging", {
    geoLocation: "US",
    groupId: 4284,
    initialDatas: [{
        group: "translations",
        key: "lang",
        value: "English",
    }],
    namespaceName: "Marketing",
    network: "staging",
    retentionInSeconds: 15724800,
});

resources:
  testStaging:
    type: akamai:EdgeKv
    properties:
      geoLocation: US
      groupId: 4284
      initialDatas:
        - group: translations
          key: lang
          value: English
      namespaceName: Marketing
      network: staging
      retentionInSeconds: 1.57248e+07

Create EdgeKv Resource

new EdgeKv(name: string, args: EdgeKvArgs, opts?: CustomResourceOptions);

@overload
def EdgeKv(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           geo_location: Optional[str] = None,
           group_id: Optional[int] = None,
           initial_datas: Optional[Sequence[EdgeKvInitialDataArgs]] = None,
           namespace_name: Optional[str] = None,
           network: Optional[str] = None,
           retention_in_seconds: Optional[int] = None)
@overload
def EdgeKv(resource_name: str,
           args: EdgeKvArgs,
           opts: Optional[ResourceOptions] = None)

func NewEdgeKv(ctx *Context, name string, args EdgeKvArgs, opts ...ResourceOption) (*EdgeKv, error)

public EdgeKv(string name, EdgeKvArgs args, CustomResourceOptions? opts = null)

public EdgeKv(String name, EdgeKvArgs args)
public EdgeKv(String name, EdgeKvArgs args, CustomResourceOptions options)

type: akamai:EdgeKv
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args EdgeKvArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EdgeKvArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

GroupId int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
NamespaceName string: - (Required) The name of the namespace.
Network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
RetentionInSeconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
GeoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
InitialDatas List<EdgeKvInitialDataArgs>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

GroupId int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
NamespaceName string: - (Required) The name of the namespace.
Network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
RetentionInSeconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
GeoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
InitialDatas []EdgeKvInitialDataArgs: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

groupId Integer: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
namespaceName String: - (Required) The name of the namespace.
network String: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds Integer: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
geoLocation String: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
initialDatas List<EdgeKvInitialDataArgs>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

groupId number: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
namespaceName string: - (Required) The name of the namespace.
network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds number: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
geoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
initialDatas EdgeKvInitialDataArgs[]: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

group_id int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
namespace_name str: - (Required) The name of the namespace.
network str: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retention_in_seconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
geo_location str: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
initial_datas Sequence[EdgeKvInitialDataArgs]: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

groupId Number: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
namespaceName String: - (Required) The name of the namespace.
network String: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds Number: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.
geoLocation String: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
initialDatas List<Property Map>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.

Outputs

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

Get an existing EdgeKv 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?: EdgeKvState, opts?: CustomResourceOptions): EdgeKv

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        geo_location: Optional[str] = None,
        group_id: Optional[int] = None,
        initial_datas: Optional[Sequence[EdgeKvInitialDataArgs]] = None,
        namespace_name: Optional[str] = None,
        network: Optional[str] = None,
        retention_in_seconds: Optional[int] = None) -> EdgeKv

func GetEdgeKv(ctx *Context, name string, id IDInput, state *EdgeKvState, opts ...ResourceOption) (*EdgeKv, error)

public static EdgeKv Get(string name, Input<string> id, EdgeKvState? state, CustomResourceOptions? opts = null)

public static EdgeKv get(String name, Output<String> id, EdgeKvState 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:

GeoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
GroupId int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
InitialDatas List<EdgeKvInitialDataArgs>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
NamespaceName string: - (Required) The name of the namespace.
Network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
RetentionInSeconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

GeoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
GroupId int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
InitialDatas []EdgeKvInitialDataArgs: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
NamespaceName string: - (Required) The name of the namespace.
Network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
RetentionInSeconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

geoLocation String: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
groupId Integer: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
initialDatas List<EdgeKvInitialDataArgs>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
namespaceName String: - (Required) The name of the namespace.
network String: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds Integer: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

geoLocation string: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
groupId number: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
initialDatas EdgeKvInitialDataArgs[]: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
namespaceName string: - (Required) The name of the namespace.
network string: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds number: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

geo_location str: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
group_id int: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
initial_datas Sequence[EdgeKvInitialDataArgs]: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
namespace_name str: - (Required) The name of the namespace.
network str: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retention_in_seconds int: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

geoLocation String: Storage location for data when creating a namespace on the production network. This can help optimize performance by storing data where most or all of your users are located. The value defaults to US on the STAGING and PRODUCTION networks. For a list of supported geoLocations on the PRODUCTION network refer to the EdgeKV documentation.
groupId Number: - (Required) The group ID for the EdgeKV namespace. This numeric value will be required in the next EdgeKV API version.
initialDatas List<Property Map>: List of key-value pairs called items to initialize the namespace. These items are valid only for database creation, updates are ignored.
namespaceName String: - (Required) The name of the namespace.
network String: The network you want to activate the EdgeKV database on. For the Staging network, specify either STAGING, STAG, or S. For the Production network, specify either PRODUCTION, PROD, or P. All values are case insensitive.
retentionInSeconds Number: - (Required) Retention period for data in this namespace, or 0 for indefinite. An update of this value will just affect new EdgeKV items.

Supporting Types

EdgeKvInitialData

Key string
Value string
Group string

Key string
Value string
Group string

key String
value String
group String

key string
value string
group string

key str
value str
group str

key String
value String
group String

Package Details

Repository: https://github.com/pulumi/pulumi-akamai
License: Apache-2.0
Notes: This Pulumi package is based on the akamai Terraform Provider.