akamai.properties.CpCode
Deprecated:
akamai.properties.CpCode has been deprecated in favor of akamai.CpCode
The akamai.CpCode
resource lets you create or reuse content provider (CP) codes. CP codes track web traffic handled by Akamai servers. Akamai gives you a CP code when you purchase a product. You need this code when you activate associated properties.
You can create additional CP codes to support more detailed billing and reporting functions.
By default, the Akamai Provider uses your existing CP code instead of creating a new one.
Attributes reference
id
- The ID of the CP code.
Example Usage
Basic usage
using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;
return await Deployment.RunAsync(() =>
{
var cpCode = new Akamai.CpCode("cpCode", new()
{
ContractId = akamai_contract.Contract.Id,
GroupId = akamai_group.Group.Id,
ProductId = "prd_Object_Delivery",
});
});
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 {
_, err := akamai.NewCpCode(ctx, "cpCode", &akamai.CpCodeArgs{
ContractId: pulumi.Any(akamai_contract.Contract.Id),
GroupId: pulumi.Any(akamai_group.Group.Id),
ProductId: pulumi.String("prd_Object_Delivery"),
})
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.CpCode;
import com.pulumi.akamai.CpCodeArgs;
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 cpCode = new CpCode("cpCode", CpCodeArgs.builder()
.contractId(akamai_contract.contract().id())
.groupId(akamai_group.group().id())
.productId("prd_Object_Delivery")
.build());
}
}
import pulumi
import pulumi_akamai as akamai
cp_code = akamai.CpCode("cpCode",
contract_id=akamai_contract["contract"]["id"],
group_id=akamai_group["group"]["id"],
product_id="prd_Object_Delivery")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const cpCode = new akamai.CpCode("cpCode", {
contractId: akamai_contract.contract.id,
groupId: akamai_group.group.id,
productId: "prd_Object_Delivery",
});
resources:
cpCode:
type: akamai:CpCode
properties:
contractId: ${akamai_contract.contract.id}
groupId: ${akamai_group.group.id}
productId: prd_Object_Delivery
Here's a real-life example that includes other data sources as dependencies
using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;
return await Deployment.RunAsync(() =>
{
var groupName = "example group name";
var cpcodeName = "My CP Code";
var exampleContract = Akamai.GetContract.Invoke(new()
{
GroupName = groupName,
});
var exampleGroup = Akamai.GetGroup.Invoke(new()
{
Name = groupName,
ContractId = exampleContract.Apply(getContractResult => getContractResult.Id),
});
var exampleCp = new Akamai.CpCode("exampleCp", new()
{
GroupId = exampleGroup.Apply(getGroupResult => getGroupResult.Id),
ContractId = exampleContract.Apply(getContractResult => getContractResult.Id),
ProductId = "prd_Object_Delivery",
});
});
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 {
groupName := "example group name"
_ := "My CP Code"
exampleContract, err := akamai.GetContract(ctx, &akamai.GetContractArgs{
GroupName: pulumi.StringRef(groupName),
}, nil)
if err != nil {
return err
}
exampleGroup, err := akamai.GetGroup(ctx, &akamai.GetGroupArgs{
Name: pulumi.StringRef(groupName),
ContractId: pulumi.StringRef(exampleContract.Id),
}, nil)
if err != nil {
return err
}
_, err = akamai.NewCpCode(ctx, "exampleCp", &akamai.CpCodeArgs{
GroupId: *pulumi.String(exampleGroup.Id),
ContractId: *pulumi.String(exampleContract.Id),
ProductId: pulumi.String("prd_Object_Delivery"),
})
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.GetContractArgs;
import com.pulumi.akamai.inputs.GetGroupArgs;
import com.pulumi.akamai.CpCode;
import com.pulumi.akamai.CpCodeArgs;
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 groupName = "example group name";
final var cpcodeName = "My CP Code";
final var exampleContract = AkamaiFunctions.getContract(GetContractArgs.builder()
.groupName(groupName)
.build());
final var exampleGroup = AkamaiFunctions.getGroup(GetGroupArgs.builder()
.name(groupName)
.contractId(exampleContract.applyValue(getContractResult -> getContractResult.id()))
.build());
var exampleCp = new CpCode("exampleCp", CpCodeArgs.builder()
.groupId(exampleGroup.applyValue(getGroupResult -> getGroupResult.id()))
.contractId(exampleContract.applyValue(getContractResult -> getContractResult.id()))
.productId("prd_Object_Delivery")
.build());
}
}
import pulumi
import pulumi_akamai as akamai
group_name = "example group name"
cpcode_name = "My CP Code"
example_contract = akamai.get_contract(group_name=group_name)
example_group = akamai.get_group(name=group_name,
contract_id=example_contract.id)
example_cp = akamai.CpCode("exampleCp",
group_id=example_group.id,
contract_id=example_contract.id,
product_id="prd_Object_Delivery")
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
const groupName = "example group name";
const cpcodeName = "My CP Code";
const exampleContract = akamai.getContract({
groupName: groupName,
});
const exampleGroup = exampleContract.then(exampleContract => akamai.getGroup({
name: groupName,
contractId: exampleContract.id,
}));
const exampleCp = new akamai.CpCode("exampleCp", {
groupId: exampleGroup.then(exampleGroup => exampleGroup.id),
contractId: exampleContract.then(exampleContract => exampleContract.id),
productId: "prd_Object_Delivery",
});
resources:
exampleCp:
type: akamai:CpCode
properties:
groupId: ${exampleGroup.id}
contractId: ${exampleContract.id}
productId: prd_Object_Delivery
variables:
groupName: example group name
cpcodeName: My CP Code
exampleGroup:
fn::invoke:
Function: akamai:getGroup
Arguments:
name: ${groupName}
contractId: ${exampleContract.id}
exampleContract:
fn::invoke:
Function: akamai:getContract
Arguments:
groupName: ${groupName}
Create CpCode Resource
new CpCode(name: string, args?: CpCodeArgs, opts?: CustomResourceOptions);
@overload
def CpCode(resource_name: str,
opts: Optional[ResourceOptions] = None,
contract: Optional[str] = None,
contract_id: Optional[str] = None,
group: Optional[str] = None,
group_id: Optional[str] = None,
name: Optional[str] = None,
product: Optional[str] = None,
product_id: Optional[str] = None)
@overload
def CpCode(resource_name: str,
args: Optional[CpCodeArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewCpCode(ctx *Context, name string, args *CpCodeArgs, opts ...ResourceOption) (*CpCode, error)
public CpCode(string name, CpCodeArgs? args = null, CustomResourceOptions? opts = null)
public CpCode(String name, CpCodeArgs args)
public CpCode(String name, CpCodeArgs args, CustomResourceOptions options)
type: akamai:properties:CpCode
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CpCodeArgs
- 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 CpCodeArgs
- 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 CpCodeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CpCodeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CpCodeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CpCode 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 CpCode resource accepts the following input properties:
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string (Required) A group's unique ID, including the
grp_
prefix.- Name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- Product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string (Required) A group's unique ID, including the
grp_
prefix.- Name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- Product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String (Required) A contract's unique ID, including the
ctr_
prefix.- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String (Required) A group's unique ID, including the
grp_
prefix.- name String
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product String
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String
- contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id string (Required) A group's unique ID, including the
grp_
prefix.- name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id string
- contract str
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract_
id str (Required) A contract's unique ID, including the
ctr_
prefix.- group str
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group_
id str (Required) A group's unique ID, including the
grp_
prefix.- name str
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product str
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product_
id str
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String (Required) A contract's unique ID, including the
ctr_
prefix.- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String (Required) A group's unique ID, including the
grp_
prefix.- name String
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product String
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String
Outputs
All input properties are implicitly available as output properties. Additionally, the CpCode 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 CpCode Resource
Get an existing CpCode 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?: CpCodeState, opts?: CustomResourceOptions): CpCode
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
contract: Optional[str] = None,
contract_id: Optional[str] = None,
group: Optional[str] = None,
group_id: Optional[str] = None,
name: Optional[str] = None,
product: Optional[str] = None,
product_id: Optional[str] = None) -> CpCode
func GetCpCode(ctx *Context, name string, id IDInput, state *CpCodeState, opts ...ResourceOption) (*CpCode, error)
public static CpCode Get(string name, Input<string> id, CpCodeState? state, CustomResourceOptions? opts = null)
public static CpCode get(String name, Output<String> id, CpCodeState 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.
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string (Required) A group's unique ID, including the
grp_
prefix.- Name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- Product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string
- Contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- Contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- Group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- Group
Id string (Required) A group's unique ID, including the
grp_
prefix.- Name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- Product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- Product
Id string
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String (Required) A contract's unique ID, including the
ctr_
prefix.- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String (Required) A group's unique ID, including the
grp_
prefix.- name String
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product String
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String
- contract string
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id string (Required) A contract's unique ID, including the
ctr_
prefix.- group string
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id string (Required) A group's unique ID, including the
grp_
prefix.- name string
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product string
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id string
- contract str
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract_
id str (Required) A contract's unique ID, including the
ctr_
prefix.- group str
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group_
id str (Required) A group's unique ID, including the
grp_
prefix.- name str
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product str
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product_
id str
- contract String
Replaced by
contract_id
. Maintained for legacy purposes.The setting "contract" has been deprecated.
- contract
Id String (Required) A contract's unique ID, including the
ctr_
prefix.- group String
Replaced by
group_id
. Maintained for legacy purposes.The setting "group" has been deprecated.
- group
Id String (Required) A group's unique ID, including the
grp_
prefix.- name String
(Required) A descriptive label for the CP code. If you're creating a new CP code, the name can't include commas, underscores, quotes, or any of these special characters: ^ # %.
- product String
Replaced by
product_id
. Maintained for legacy purposes.The setting "product" has been deprecated.
- product
Id String
Import
Basic Usagehcl resource “akamai_cp_code” “example” {
(resource arguments)
} You can import your Akamai CP codes using a comma-delimited string of the CP code, contract, and group IDs. You have to enter the IDs in this ordercpcode_id,contract_id,group_id
For example
$ pulumi import akamai:properties/cpCode:CpCode example cpc_123,ctr_1-AB123,grp_123
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.