The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

Package @pulumi/akamai

This page documents the language specification for the akamai package. If you're looking for help working with the inputs, outputs, or functions of akamai resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-akamai repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-akamai repo.

var akamai = require("@pulumi/akamai");
import * as akamai from "@pulumi/akamai";

Modules

Resources

Functions

Others

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the akamai package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getContract

getContract(args?: GetContractArgs, opts?: pulumi.InvokeOptions): Promise<GetContractResult>

Use akamai.getContract data source to retrieve a group id.

Example Usage

Function getGroup

getGroup(args?: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>

Use akamai.getGroup data source to retrieve a group id.

Example Usage

Others

interface GetContractArgs

interface GetContractArgs

A collection of arguments for invoking getContract.

property group

group?: undefined | string;

— (Optional) The group within which the contract can be found.

interface GetContractResult

interface GetContractResult

A collection of values returned by getContract.

property group

group?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetGroupArgs

interface GetGroupArgs

A collection of arguments for invoking getGroup.

property contract

contract?: undefined | string;

— (Optional) The contract ID

property name

name?: undefined | string;

— (Required) The group name.

interface GetGroupResult

interface GetGroupResult

A collection of values returned by getGroup.

property contract

contract?: undefined | string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name?: undefined | string;

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property dns

dns?: pulumi.Input<pulumi.Input<ProviderDn>[]>;

property dnsSection

dnsSection?: pulumi.Input<string>;

property edgerc

edgerc?: pulumi.Input<string>;

property gtmSection

gtmSection?: pulumi.Input<string>;

property gtms

gtms?: pulumi.Input<pulumi.Input<ProviderGtm>[]>;

property papiSection

papiSection?: pulumi.Input<string>;

property properties

properties?: pulumi.Input<pulumi.Input<ProviderProperty>[]>;

property propertySection

propertySection?: pulumi.Input<string>;