class CfnEnvironment (construct)

Language	Type name
.NET	Amazon.CDK.aws_datazone.CfnEnvironment
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdatazone#CfnEnvironment
Java	software.amazon.awscdk.services.datazone.CfnEnvironment
Python	aws_cdk.aws_datazone.CfnEnvironment
TypeScript	aws-cdk-lib » aws_datazone » CfnEnvironment

Implements IConstruct, IDependable, IInspectable

The AWS::DataZone::Environment resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datazone as datazone } from 'aws-cdk-lib';
const cfnEnvironment = new datazone.CfnEnvironment(this, 'MyCfnEnvironment', {
  domainIdentifier: 'domainIdentifier',
  name: 'name',
  projectIdentifier: 'projectIdentifier',

  // the properties below are optional
  description: 'description',
  environmentAccountIdentifier: 'environmentAccountIdentifier',
  environmentAccountRegion: 'environmentAccountRegion',
  environmentProfileIdentifier: 'environmentProfileIdentifier',
  environmentRoleArn: 'environmentRoleArn',
  glossaryTerms: ['glossaryTerms'],
  userParameters: [{
    name: 'name',
    value: 'value',
  }],
});

Initializer

new CfnEnvironment(scope: Construct, id: string, props: CfnEnvironmentProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnEnvironmentProps — Resource properties.

Construct Props

Name	Type	Description
domainIdentifier	string	The identifier of the Amazon DataZone domain in which the environment is created.
name	string	The name of the Amazon DataZone environment.
projectIdentifier	string	The identifier of the Amazon DataZone project in which this environment is created.
description?	string	The description of the environment.
environmentAccountIdentifier?	string	The identifier of the AWS account in which an environment exists.
environmentAccountRegion?	string	The AWS Region in which an environment exists.
environmentProfileIdentifier?	string	The identifier of the environment profile that is used to create this Amazon DataZone environment.
environmentRoleArn?	string	The ARN of the environment role.
glossaryTerms?	string[]	The glossary terms that can be used in this Amazon DataZone environment.
userParameters?	IResolvable | IResolvable | EnvironmentParameterProperty[]	The user parameters of this Amazon DataZone environment.

---

domainIdentifier

Type: string

The identifier of the Amazon DataZone domain in which the environment is created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-domainidentifier

---

name

Type: string

The name of the Amazon DataZone environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-name

---

projectIdentifier

Type: string

The identifier of the Amazon DataZone project in which this environment is created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-projectidentifier

---

description?

Type: string (optional)

The description of the environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-description

---

environmentAccountIdentifier?

Type: string (optional)

The identifier of the AWS account in which an environment exists.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountidentifier

---

environmentAccountRegion?

Type: string (optional)

The AWS Region in which an environment exists.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountregion

---

environmentProfileIdentifier?

Type: string (optional)

The identifier of the environment profile that is used to create this Amazon DataZone environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentprofileidentifier

---

environmentRoleArn?

Type: string (optional)

The ARN of the environment role.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentrolearn

---

glossaryTerms?

Type: string[] (optional)

The glossary terms that can be used in this Amazon DataZone environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-glossaryterms

---

userParameters?

Type: IResolvable | IResolvable | EnvironmentParameterProperty[] (optional)

The user parameters of this Amazon DataZone environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-userparameters

Properties

Name	Type	Description
attrAwsAccountId	string	The identifier of the AWS account in which an environment exists.
attrAwsAccountRegion	string	The AWS Region in which an environment exists.
attrCreatedAt	string	The timestamp of when the environment was created.
attrCreatedBy	string	The Amazon DataZone user who created the environment.
attrDomainId	string	The identifier of the Amazon DataZone domain in which the environment exists.
attrEnvironmentBlueprintId	string	The identifier of a blueprint with which an environment profile is created.
attrEnvironmentProfileId	string	The identifier of the environment profile with which the environment was created.
attrId	string	The identifier of the environment.
attrProjectId	string	The identifier of the project in which the environment exists.
attrProvider	string	The provider of the environment.
attrStatus	string	The status of the environment.
attrUpdatedAt	string	The timestamp of when the environment was updated.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
domainIdentifier	string	The identifier of the Amazon DataZone domain in which the environment is created.
logicalId	string	The logical ID for this CloudFormation stack element.
name	string	The name of the Amazon DataZone environment.
node	Node	The tree node.
projectIdentifier	string	The identifier of the Amazon DataZone project in which this environment is created.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
description?	string	The description of the environment.
environmentAccountIdentifier?	string	The identifier of the AWS account in which an environment exists.
environmentAccountRegion?	string	The AWS Region in which an environment exists.
environmentProfileIdentifier?	string	The identifier of the environment profile that is used to create this Amazon DataZone environment.
environmentRoleArn?	string	The ARN of the environment role.
glossaryTerms?	string[]	The glossary terms that can be used in this Amazon DataZone environment.
userParameters?	IResolvable | IResolvable | EnvironmentParameterProperty[]	The user parameters of this Amazon DataZone environment.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrAwsAccountId

Type: string

The identifier of the AWS account in which an environment exists.

---

attrAwsAccountRegion

Type: string

The AWS Region in which an environment exists.

---

attrCreatedAt

Type: string

The timestamp of when the environment was created.

---

attrCreatedBy

Type: string

The Amazon DataZone user who created the environment.

---

attrDomainId

Type: string

The identifier of the Amazon DataZone domain in which the environment exists.

---

attrEnvironmentBlueprintId

Type: string

The identifier of a blueprint with which an environment profile is created.

---

attrEnvironmentProfileId

Type: string

The identifier of the environment profile with which the environment was created.

---

attrId

Type: string

The identifier of the environment.

---

attrProjectId

Type: string

The identifier of the project in which the environment exists.

---

attrProvider

Type: string

The provider of the environment.

---

attrStatus

Type: string

The status of the environment.

---

attrUpdatedAt

Type: string

The timestamp of when the environment was updated.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

domainIdentifier

Type: string

The identifier of the Amazon DataZone domain in which the environment is created.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

name

Type: string

The name of the Amazon DataZone environment.

---

node

Type: Node

The tree node.

---

projectIdentifier

Type: string

The identifier of the Amazon DataZone project in which this environment is created.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

description?

Type: string (optional)

The description of the environment.

---

environmentAccountIdentifier?

Type: string (optional)

The identifier of the AWS account in which an environment exists.

---

environmentAccountRegion?

Type: string (optional)

The AWS Region in which an environment exists.

---

environmentProfileIdentifier?

Type: string (optional)

The identifier of the environment profile that is used to create this Amazon DataZone environment.

---

environmentRoleArn?

Type: string (optional)

The ARN of the environment role.

---

glossaryTerms?

Type: string[] (optional)

The glossary terms that can be used in this Amazon DataZone environment.

---

userParameters?

Type: IResolvable | IResolvable | EnvironmentParameterProperty[] (optional)

The user parameters of this Amazon DataZone environment.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }