policy

Documentation

Overview

policy

Index

• func NewPolicy_Override(p Policy, scope constructs.Construct, id *string, config *PolicyConfig)
• func Policy_IsConstruct(x interface{}) *bool
• func Policy_IsTerraformElement(x interface{}) *bool
• type Policy
  • func NewPolicy(scope constructs.Construct, id *string, config *PolicyConfig) Policy
• type PolicyConfig

Functions

func NewPolicy_Override

func NewPolicy_Override(p Policy, scope constructs.Construct, id *string, config *PolicyConfig)

func Policy_IsConstruct

func Policy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func Policy_IsTerraformElement

func Policy_IsTerraformElement(x interface{}) *bool

Experimental.

Types

type Policy

type Policy interface {
	cdktf.TerraformModule
	Actions() *[]*string
	SetActions(val *[]*string)
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	// The tree node.
	Node() constructs.Node
	Principals() *map[string]*string
	SetPrincipals(val *map[string]*string)
	// Experimental.
	Providers() *[]interface{}
	// Experimental.
	RawOverrides() interface{}
	Resources() *[]*string
	SetResources(val *[]*string)
	// Experimental.
	SkipAssetCreationFromLocalModules() *bool
	// Experimental.
	Source() *string
	// Experimental.
	Version() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	AddProvider(provider interface{})
	// Experimental.
	GetString(output *string) *string
	// Experimental.
	InterpolationForOutput(moduleOutput *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Experimental.
	ToTerraform() interface{}
}

Defines an Policy based on a Terraform module.

Source at ./.nitric/modules/policy

func NewPolicy

func NewPolicy(scope constructs.Construct, id *string, config *PolicyConfig) Policy

type PolicyConfig

type PolicyConfig struct {
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Providers *[]interface{} `field:"optional" json:"providers" yaml:"providers"`
	// Experimental.
	SkipAssetCreationFromLocalModules *bool `field:"optional" json:"skipAssetCreationFromLocalModules" yaml:"skipAssetCreationFromLocalModules"`
	// actions to allow.
	Actions *[]*string `field:"required" json:"actions" yaml:"actions"`
	// principals (roles) to apply the policies to The property type contains a map, they have special handling, please see {@link cdk.tf /module-map-inputs the docs}.
	Principals *map[string]*string `field:"required" json:"principals" yaml:"principals"`
	// resources to apply the policies to.
	Resources *[]*string `field:"required" json:"resources" yaml:"resources"`
}