Class CloudflareZoneManager

Provides operations on Cloudflare Zone using Pulumi

A new instance of this class is injected into CommonCloudflareConstruct constructor.
If a custom construct extends CommonCloudflareConstruct, an instance is available within the context.

Example

import { CommonCloudflareConstruct } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonCloudflareConstruct {
  constructor(parent: pulumi.ComponentResource, id: string, props: CommonCloudflareStackProps) {
    super(parent, id, props)
    this.props = props
    this.zoneManager.createZone('MyZone', this, props)
  }
}

Index

Constructors

constructor

Methods

createZone createZoneCacheReserve createZoneCacheVariants createZoneDnssec createZoneDnsSettings createZoneHold createZoneLockdown createZoneSetting resolveZone

Constructors

constructor

new CloudflareZoneManager(): CloudflareZoneManager
Returns CloudflareZoneManager

Methods

createZone

createZone(id: string, scope: CommonCloudflareConstruct, props: ZoneProps): Zone
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneProps
  zone properties
Returns Zone
See
[Pulumi Cloudflare Zone]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zone/
- Defined in packages/cloudflare/src/services/zone/main.ts:51

createZoneCacheReserve

createZoneCacheReserve(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneCacheReserveProps,
): ZoneCacheReserve
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneCacheReserveProps
  zone cache reserve properties
Returns ZoneCacheReserve
See
[Pulumi Cloudflare ZoneCacheReserve]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonecachereserve/
- Defined in packages/cloudflare/src/services/zone/main.ts:84

createZoneCacheVariants

createZoneCacheVariants(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneCacheVariantsProps,
): ZoneCacheVariants
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneCacheVariantsProps
  zone cache variants properties
Returns ZoneCacheVariants
See
[Pulumi Cloudflare ZoneCacheVariants]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonecachevariants/
- Defined in packages/cloudflare/src/services/zone/main.ts:106

createZoneDnssec

createZoneDnssec(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneDnssecProps,
): ZoneDnssec
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneDnssecProps
  zone dnssec properties
Returns ZoneDnssec
See
[Pulumi Cloudflare ZoneDnssec]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonednssec/
- Defined in packages/cloudflare/src/services/zone/main.ts:128

createZoneDnsSettings

createZoneDnsSettings(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneSettingProps,
): ZoneSetting
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneSettingProps
  zone dns settings properties
Returns ZoneSetting
See
[Pulumi Cloudflare ZoneSetting]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonesetting/
- Defined in packages/cloudflare/src/services/zone/main.ts:194

createZoneHold

createZoneHold(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneHoldProps,
): ZoneHold
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneHoldProps
  zone hold properties
Returns ZoneHold
See
[Pulumi Cloudflare ZoneHold]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonehold/
- Defined in packages/cloudflare/src/services/zone/main.ts:150

createZoneLockdown

createZoneLockdown(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneLockdownProps,
): ZoneLockdown
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneLockdownProps
  zone lockdown properties
Returns ZoneLockdown
See
[Pulumi Cloudflare ZoneLockdown]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonelockdown/
- Defined in packages/cloudflare/src/services/zone/main.ts:172

createZoneSetting

createZoneSetting(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ZoneSettingProps,
): ZoneSetting
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ZoneSettingProps
  zone setting properties
Returns ZoneSetting
See
[Pulumi Cloudflare ZoneSetting]https://www.pulumi.com/registry/packages/cloudflare/api-docs/zonesetting/
- Defined in packages/cloudflare/src/services/zone/main.ts:218

resolveZone

resolveZone(
    id: string,
    scope: CommonCloudflareConstruct,
    options?: GetZoneProps,
): Output<GetZoneResult>
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- Optionaloptions: GetZoneProps
  optional zone lookup properties
Returns Output<GetZoneResult>
See
[Pulumi Cloudflare getZone]https://www.pulumi.com/registry/packages/cloudflare/api-docs/getzone/
- Defined in packages/cloudflare/src/services/zone/main.ts:72

Class CloudflareZoneManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns CloudflareZoneManager

Methods

createZone

Parameters

Returns Zone

See

createZoneCacheReserve

Parameters

Returns ZoneCacheReserve

See

createZoneCacheVariants

Parameters

Returns ZoneCacheVariants

See

createZoneDnssec

Parameters

Returns ZoneDnssec

See

createZoneDnsSettings

Parameters

Returns ZoneSetting

See

createZoneHold

Parameters

Returns ZoneHold

See

createZoneLockdown

Parameters

Returns ZoneLockdown

See

createZoneSetting

Parameters

Returns ZoneSetting

See

resolveZone

Parameters

Returns Output<GetZoneResult>

See

Settings

On This Page