Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. EdgeKv
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.EdgeKv

Explore with Pulumi AI

akamai logo
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

    Create EdgeKv Resource

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

    Constructor syntax

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

@overload
def EdgeKv(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           group_id: Optional[int] = None,
           namespace_name: Optional[str] = None,
           network: Optional[str] = None,
           retention_in_seconds: Optional[int] = None,
           geo_location: Optional[str] = None,
           initial_datas: Optional[Sequence[EdgeKvInitialDataArgs]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var edgeKvResource = new Akamai.EdgeKv("edgeKvResource", new()
{
    GroupId = 0,
    NamespaceName = "string",
    Network = "string",
    RetentionInSeconds = 0,
    GeoLocation = "string",
});

    example, err := akamai.NewEdgeKv(ctx, "edgeKvResource", &akamai.EdgeKvArgs{
	GroupId:            pulumi.Int(0),
	NamespaceName:      pulumi.String("string"),
	Network:            pulumi.String("string"),
	RetentionInSeconds: pulumi.Int(0),
	GeoLocation:        pulumi.String("string"),
})

    var edgeKvResource = new EdgeKv("edgeKvResource", EdgeKvArgs.builder()
    .groupId(0)
    .namespaceName("string")
    .network("string")
    .retentionInSeconds(0)
    .geoLocation("string")
    .build());

    edge_kv_resource = akamai.EdgeKv("edgeKvResource",
    group_id=0,
    namespace_name="string",
    network="string",
    retention_in_seconds=0,
    geo_location="string")

    const edgeKvResource = new akamai.EdgeKv("edgeKvResource", {
    groupId: 0,
    namespaceName: "string",
    network: "string",
    retentionInSeconds: 0,
    geoLocation: "string",
});

    type: akamai:EdgeKv
properties:
    geoLocation: string
    groupId: 0
    namespaceName: string
    network: string
    retentionInSeconds: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EdgeKv resource accepts the following input properties:

    GroupId int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    NamespaceName string
    Name for the EKV namespace
    Network string
    The network on which the namespace will be activated
    RetentionInSeconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    GeoLocation string
    Storage location for data
    InitialDatas List<EdgeKvInitialData>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    GroupId int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    NamespaceName string
    Name for the EKV namespace
    Network string
    The network on which the namespace will be activated
    RetentionInSeconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    GeoLocation string
    Storage location for data
    InitialDatas []EdgeKvInitialDataArgs
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    groupId Integer
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    namespaceName String
    Name for the EKV namespace
    network String
    The network on which the namespace will be activated
    retentionInSeconds Integer
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation String
    Storage location for data
    initialDatas List<EdgeKvInitialData>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    groupId number
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    namespaceName string
    Name for the EKV namespace
    network string
    The network on which the namespace will be activated
    retentionInSeconds number
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation string
    Storage location for data
    initialDatas EdgeKvInitialData[]
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    group_id int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    namespace_name str
    Name for the EKV namespace
    network str
    The network on which the namespace will be activated
    retention_in_seconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geo_location str
    Storage location for data
    initial_datas Sequence[EdgeKvInitialDataArgs]
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    groupId Number
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    namespaceName String
    Name for the EKV namespace
    network String
    The network on which the namespace will be activated
    retentionInSeconds Number
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation String
    Storage location for data
    initialDatas List<Property Map>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    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
    GroupId int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    InitialDatas List<EdgeKvInitialData>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    NamespaceName string
    Name for the EKV namespace
    Network string
    The network on which the namespace will be activated
    RetentionInSeconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    GeoLocation string
    Storage location for data
    GroupId int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    InitialDatas []EdgeKvInitialDataArgs
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    NamespaceName string
    Name for the EKV namespace
    Network string
    The network on which the namespace will be activated
    RetentionInSeconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation String
    Storage location for data
    groupId Integer
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    initialDatas List<EdgeKvInitialData>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    namespaceName String
    Name for the EKV namespace
    network String
    The network on which the namespace will be activated
    retentionInSeconds Integer
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation string
    Storage location for data
    groupId number
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    initialDatas EdgeKvInitialData[]
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    namespaceName string
    Name for the EKV namespace
    network string
    The network on which the namespace will be activated
    retentionInSeconds number
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geo_location str
    Storage location for data
    group_id int
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    initial_datas Sequence[EdgeKvInitialDataArgs]
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    namespace_name str
    Name for the EKV namespace
    network str
    The network on which the namespace will be activated
    retention_in_seconds int
    Retention period for data in this namespace. An update of this value will just affect new EKV items.
    geoLocation String
    Storage location for data
    groupId Number
    Namespace ACC group ID. It will be used in EdgeKV API v2. Not updatable.
    initialDatas List<Property Map>
    List of pairs to initialize the namespace. Just meaningful for creation, updates will be ignored.

    Deprecated: The attribute 'initial_data' has been deprecated. To manage edgeKV items use 'akamai_edgekv_group_items' resource instead.

    namespaceName String
    Name for the EKV namespace
    network String
    The network on which the namespace will be activated
    retentionInSeconds Number
    Retention period for data in this namespace. An update of this value will just affect new EKV items.

    Supporting Types

    EdgeKvInitialData, EdgeKvInitialDataArgs

    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
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-akamai