Class CloudflareApiShieldManager

Provides operations on Cloudflare Api Shield

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, CommonCloudflareConstruct } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonCloudflareConstruct {
  constructor(parent: Construct, id: string, props: CommonCloudflareStackProps) {
    super(parent, id, props)
    this.props = props
    this.apiShieldManager.createApiShield('MyApiShield', this, props)
  }
}

Index

Constructors

constructor

Methods

createApiShield createApiShieldOperation createApiShieldOperationSchemaValidationSettings createApiShieldSchema createApiShieldSchemaValidationSettings

Constructors

constructor

new CloudflareApiShieldManager(): CloudflareApiShieldManager
Returns CloudflareApiShieldManager

Methods

createApiShield

createApiShield(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ApiShieldProps,
): ApiShield
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ApiShieldProps
  api shield properties
Returns ApiShield
See
[Pulumi API Shield]https://www.pulumi.com/registry/packages/cloudflare/api-docs/apishield/
- Defined in packages/cloudflare/src/services/api-shield/main.ts:45

createApiShieldOperation

createApiShieldOperation(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ApiShieldOperationProps,
): ApiShieldOperation
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ApiShieldOperationProps
  api shield operation properties
Returns ApiShieldOperation
See
[Pulumi API Shield Operation]https://www.pulumi.com/registry/packages/cloudflare/api-docs/apishieldoperation/
- Defined in packages/cloudflare/src/services/api-shield/main.ts:119

createApiShieldOperationSchemaValidationSettings

createApiShieldOperationSchemaValidationSettings(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ApiShieldOperationSchemaValidationSettingsProps,
): ApiShieldOperationSchemaValidationSettings
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ApiShieldOperationSchemaValidationSettingsProps
  api shield operation schema validation settings properties
Returns ApiShieldOperationSchemaValidationSettings
See
[Pulumi API Shield Operation Schema Validation Settings]https://www.pulumi.com/registry/packages/cloudflare/api-docs/apishieldoperationschemavalidationsettings/
- Defined in packages/cloudflare/src/services/api-shield/main.ts:142

createApiShieldSchema

createApiShieldSchema(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ApiShieldSchemaProps,
): ApiShieldSchema
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ApiShieldSchemaProps
  api shield schema properties
Returns ApiShieldSchema
See
[Pulumi API Shield Schema]https://www.pulumi.com/registry/packages/cloudflare/api-docs/apishieldschema/
- Defined in packages/cloudflare/src/services/api-shield/main.ts:68

createApiShieldSchemaValidationSettings

createApiShieldSchemaValidationSettings(
    id: string,
    scope: CommonCloudflareConstruct,
    props: ApiShieldSchemaValidationSettingsProps,
): ApiShieldSchemaValidationSettings
Parameters
- id: string
  scoped id of the resource
- scope: CommonCloudflareConstruct
  scope in which this resource is defined
- props: ApiShieldSchemaValidationSettingsProps
  api shield schema validation settings properties
Returns ApiShieldSchemaValidationSettings
See
[Pulumi API Shield Schema Validation Settings]https://www.pulumi.com/registry/packages/cloudflare/api-docs/apishieldschemavalidationsettings/
- Defined in packages/cloudflare/src/services/api-shield/main.ts:92

Class CloudflareApiShieldManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns CloudflareApiShieldManager

Methods

createApiShield

Parameters

Returns ApiShield

See

createApiShieldOperation

Parameters

Returns ApiShieldOperation

See

createApiShieldOperationSchemaValidationSettings

Parameters

Returns ApiShieldOperationSchemaValidationSettings

See

createApiShieldSchema

Parameters

Returns ApiShieldSchema

See

createApiShieldSchemaValidationSettings

Parameters

Returns ApiShieldSchemaValidationSettings

See

Settings

On This Page