Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Module types/output

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.

namespace config

namespace edgedns

namespace properties

namespace trafficmanagement

APIs

namespace config

interface Appsecs

interface Appsecs

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface Config

interface Config

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface Dns

interface Dns

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface Gtm

interface Gtm

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface Property

interface Property

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

namespace edgedns

interface DnsZoneTsigKey

interface DnsZoneTsigKey

property algorithm

algorithm: string;

property name

name: string;

property secret

secret: string;

namespace properties

interface PropertyOrigin

interface PropertyOrigin

property cacheKeyHostname

cacheKeyHostname?: undefined | string;

property compress

compress?: undefined | false | true;

property enableTrueClientIp

enableTrueClientIp?: undefined | false | true;

property forwardHostname

forwardHostname?: undefined | string;

property hostname

hostname?: undefined | string;

property port

port?: undefined | number;

interface PropertyRuleError

interface PropertyRuleError

property behaviorName

behaviorName?: undefined | string;

property detail

detail?: undefined | string;

property errorLocation

errorLocation?: undefined | string;

property instance

instance?: undefined | string;

property statusCode

statusCode?: undefined | number;

property title

title?: undefined | string;

property type

type?: undefined | string;

interface PropertyRuleWarning

interface PropertyRuleWarning

property behaviorName

behaviorName?: undefined | string;

property detail

detail?: undefined | string;

property errorLocation

errorLocation?: undefined | string;

property instance

instance?: undefined | string;

property statusCode

statusCode?: undefined | number;

property title

title?: undefined | string;

property type

type?: undefined | string;

interface PropertyVariablesVariable

interface PropertyVariablesVariable

property variables

variables?: PropertyVariablesVariableVariable[];

interface PropertyVariablesVariableVariable

interface PropertyVariablesVariableVariable

property description

description?: undefined | string;

property hidden

hidden: boolean;

property name

name: string;

property sensitive

sensitive: boolean;

property value

value?: undefined | string;

namespace trafficmanagement

interface GtmASmapAssignment

interface GtmASmapAssignment

property asNumbers

asNumbers: number[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmASmapDefaultDatacenter

interface GtmASmapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmCidrmapAssignment

interface GtmCidrmapAssignment

property blocks

blocks?: string[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmCidrmapDefaultDatacenter

interface GtmCidrmapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmDatacenterDefaultLoadObject

interface GtmDatacenterDefaultLoadObject

property loadObject

loadObject?: undefined | string;

property loadObjectPort

loadObjectPort?: undefined | number;

property loadServers

loadServers?: string[];

interface GtmGeomapAssignment

interface GtmGeomapAssignment

property countries

countries?: string[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmGeomapDefaultDatacenter

interface GtmGeomapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmPropertyLivenessTest

interface GtmPropertyLivenessTest

property answersRequired

answersRequired?: undefined | false | true;

property disableNonstandardPortWarning

disableNonstandardPortWarning?: undefined | false | true;

property disabled

disabled?: undefined | false | true;

property errorPenalty

errorPenalty?: undefined | number;

property httpError3xx

httpError3xx?: undefined | false | true;

property httpError4xx

httpError4xx?: undefined | false | true;

property httpError5xx

httpError5xx?: undefined | false | true;

property httpHeaders

httpHeaders?: GtmPropertyLivenessTestHttpHeader[];

property name

name: string;

property peerCertificateVerification

peerCertificateVerification?: undefined | false | true;

property recursionRequested

recursionRequested?: undefined | false | true;

property requestString

requestString?: undefined | string;

property resourceType

resourceType?: undefined | string;

property responseString

responseString?: undefined | string;

property sslClientCertificate

sslClientCertificate?: undefined | string;

property sslClientPrivateKey

sslClientPrivateKey?: undefined | string;

property testInterval

testInterval: number;

property testObject

testObject: string;

property testObjectPassword

testObjectPassword?: undefined | string;

property testObjectPort

testObjectPort?: undefined | number;

property testObjectProtocol

testObjectProtocol: string;

property testObjectUsername

testObjectUsername?: undefined | string;

property testTimeout

testTimeout: number;

property timeoutPenalty

timeoutPenalty?: undefined | number;

interface GtmPropertyLivenessTestHttpHeader

interface GtmPropertyLivenessTestHttpHeader

property name

name?: undefined | string;

property value

value?: undefined | string;

interface GtmPropertyStaticRrSet

interface GtmPropertyStaticRrSet

property rdatas

rdatas?: string[];

property ttl

ttl?: undefined | number;

property type

type?: undefined | string;

interface GtmPropertyTrafficTarget

interface GtmPropertyTrafficTarget

property datacenterId

datacenterId?: undefined | number;

property enabled

enabled?: undefined | false | true;

property handoutCname

handoutCname?: undefined | string;

property name

name?: undefined | string;

property servers

servers?: string[];

property weight

weight?: undefined | number;

interface GtmResourceResourceInstance

interface GtmResourceResourceInstance

property datacenterId

datacenterId: number;

property loadObject

loadObject?: undefined | string;

property loadObjectPort

loadObjectPort?: undefined | number;

property loadServers

loadServers?: string[];

property useDefaultLoadObject

useDefaultLoadObject?: undefined | false | true;

APIs

interface DnsZoneTsigKey

interface DnsZoneTsigKey

property algorithm

algorithm: string;

property name

name: string;

key name * algorithm * secret

property secret

secret: string;

interface GetContractsContract

interface GetContractsContract

property contractId

contractId: string;

property contractTypeName

contractTypeName: string;

interface GetGroupsGroup

interface GetGroupsGroup

property contractIds

contractIds: string[];

property groupId

groupId: string;

property groupName

groupName: string;

property parentGroupId

parentGroupId: string;

interface GetPropertiesProperty

interface GetPropertiesProperty

property contractId

contractId: string;

property groupId

groupId: string;

property latestVersion

latestVersion: number;

property note

note: string;

property productId

productId: string;

property productionVersion

productionVersion: number;

property propertyId

propertyId: string;

property propertyName

propertyName: string;

property ruleFormat

ruleFormat: string;

property stagingVersion

stagingVersion: number;

interface GetPropertyProductsProduct

interface GetPropertyProductsProduct

property productId

productId: string;

property productName

productName: string;

interface GetPropertyRulesTemplateVariable

interface GetPropertyRulesTemplateVariable

property name

name: string;

property type

type?: undefined | string;

property value

value: string;

interface GtmAsmapAssignment

interface GtmAsmapAssignment

property asNumbers

asNumbers: number[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmAsmapDefaultDatacenter

interface GtmAsmapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmCidrmapAssignment

interface GtmCidrmapAssignment

property blocks

blocks?: string[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmCidrmapDefaultDatacenter

interface GtmCidrmapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmDatacenterDefaultLoadObject

interface GtmDatacenterDefaultLoadObject

property loadObject

loadObject?: undefined | string;

property loadObjectPort

loadObjectPort?: undefined | number;

property loadServers

loadServers?: string[];
  • city
  • cloneOf

interface GtmGeomapAssignment

interface GtmGeomapAssignment

property countries

countries?: string[];

property datacenterId

datacenterId: number;

property nickname

nickname: string;

interface GtmGeomapDefaultDatacenter

interface GtmGeomapDefaultDatacenter

property datacenterId

datacenterId: number;

property nickname

nickname?: undefined | string;

interface GtmPropertyLivenessTest

interface GtmPropertyLivenessTest

property answersRequired

answersRequired?: undefined | false | true;

property disableNonstandardPortWarning

disableNonstandardPortWarning?: undefined | false | true;
  • errorPenalty

property disabled

disabled?: undefined | false | true;

property errorPenalty

errorPenalty?: undefined | number;

property httpError3xx

httpError3xx?: undefined | false | true;

property httpError4xx

httpError4xx?: undefined | false | true;

property httpError5xx

httpError5xx?: undefined | false | true;

property httpHeaders

httpHeaders?: GtmPropertyLivenessTestHttpHeader[];

name value

property name

name: string;

Liveness test name * testInterval * testObjectProtocol * testTimeout

property peerCertificateVerification

peerCertificateVerification?: undefined | false | true;

property recursionRequested

recursionRequested?: undefined | false | true;
  • requestString
  • resourceType
  • responseString
  • sslClientCertificate
  • sslClientPrivateKey
  • testObject
  • testObjectPassword
  • testObjectPort
  • testObjectUsername
  • timeoutPenalty

property requestString

requestString?: undefined | string;

property resourceType

resourceType?: undefined | string;

property responseString

responseString?: undefined | string;

property sslClientCertificate

sslClientCertificate?: undefined | string;

property sslClientPrivateKey

sslClientPrivateKey?: undefined | string;

property testInterval

testInterval: number;

property testObject

testObject: string;

property testObjectPassword

testObjectPassword?: undefined | string;

property testObjectPort

testObjectPort?: undefined | number;

property testObjectProtocol

testObjectProtocol: string;

property testObjectUsername

testObjectUsername?: undefined | string;

property testTimeout

testTimeout: number;

property timeoutPenalty

timeoutPenalty?: undefined | number;

interface GtmPropertyLivenessTestHttpHeader

interface GtmPropertyLivenessTestHttpHeader

property name

name?: undefined | string;

Liveness test name * testInterval * testObjectProtocol * testTimeout

property value

value?: undefined | string;

interface GtmPropertyStaticRrSet

interface GtmPropertyStaticRrSet

property rdatas

rdatas?: string[];

property ttl

ttl?: undefined | number;

property type

type?: undefined | string;

Property type * scoreAggregationType

interface GtmPropertyTrafficTarget

interface GtmPropertyTrafficTarget

property datacenterId

datacenterId?: undefined | number;

property enabled

enabled?: undefined | false | true;
  • weight

property handoutCname

handoutCname?: undefined | string;

property name

name?: undefined | string;

Liveness test name * testInterval * testObjectProtocol * testTimeout

property servers

servers?: string[];

property weight

weight?: undefined | number;

interface GtmResourceResourceInstance

interface GtmResourceResourceInstance

property datacenterId

datacenterId: number;

property loadObject

loadObject?: undefined | string;

property loadObjectPort

loadObjectPort?: undefined | number;

property loadServers

loadServers?: string[];

property useDefaultLoadObject

useDefaultLoadObject?: undefined | false | true;
  • hostHeader
  • leastSquaresDecay
  • upperBound
  • description
  • leaderString
  • constrainedProperty
  • loadImbalancePercent
  • maxUMultiplicativeIncrement
  • decayRate

interface PropertyOrigin

interface PropertyOrigin

property cacheKeyHostname

cacheKeyHostname?: undefined | string;

property compress

compress?: undefined | false | true;

property enableTrueClientIp

enableTrueClientIp?: undefined | false | true;

property forwardHostname

forwardHostname?: undefined | string;

property hostname

hostname?: undefined | string;

property port

port?: undefined | number;

interface PropertyRuleError

interface PropertyRuleError

property behaviorName

behaviorName?: undefined | string;

property detail

detail?: undefined | string;

property errorLocation

errorLocation?: undefined | string;

property instance

instance?: undefined | string;

property statusCode

statusCode?: undefined | number;

property title

title?: undefined | string;

property type

type?: undefined | string;

interface PropertyRuleWarning

interface PropertyRuleWarning

property behaviorName

behaviorName?: undefined | string;

property detail

detail?: undefined | string;

property errorLocation

errorLocation?: undefined | string;

property instance

instance?: undefined | string;

property statusCode

statusCode?: undefined | number;

property title

title?: undefined | string;

property type

type?: undefined | string;

interface PropertyVariablesVariable

interface PropertyVariablesVariable

property variables

variables?: PropertyVariablesVariableVariable[];

interface PropertyVariablesVariableVariable

interface PropertyVariablesVariableVariable

property description

description?: undefined | string;

property hidden

hidden: boolean;

property name

name: string;

property sensitive

sensitive: boolean;

property value

value?: undefined | string;

interface ProviderAppsec

interface ProviderAppsec

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface ProviderConfig

interface ProviderConfig

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface ProviderDns

interface ProviderDns

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface ProviderGtm

interface ProviderGtm

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;

interface ProviderProperty

interface ProviderProperty

property accessToken

accessToken?: undefined | string;

property accountKey

accountKey?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property clientToken

clientToken?: undefined | string;

property host

host?: undefined | string;

property maxBody

maxBody?: undefined | number;