Skip to content
v2.274.0

CfnEnvironmentProps Struct ​

Properties for defining a CfnEnvironment.

Example ​

ts
// 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 cfnEnvironmentProps: datazone.CfnEnvironmentProps = {
  domainIdentifier: 'domainIdentifier',
  name: 'name',
  projectIdentifier: 'projectIdentifier',

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

Properties ​

deploymentOrderoptionalnumberdeployment_orderoptionalint | floatdeploymentOrderoptionalNumberDeploymentOrderoptionaldoubleDeploymentOrderoptional*float64#
The deployment order for the environment.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the environment.
domainIdentifierstringdomain_identifierstrdomainIdentifierStringDomainIdentifierstringDomainIdentifier*stringrequired#
The identifier of the Amazon DataZone domain in which the environment is created.
environmentAccountIdentifieroptionalstringenvironment_account_identifieroptionalstrenvironmentAccountIdentifieroptionalStringEnvironmentAccountIdentifieroptionalstringEnvironmentAccountIdentifieroptional*string#
The identifier of the AWS account in which an environment exists.
environmentAccountRegionoptionalstringenvironment_account_regionoptionalstrenvironmentAccountRegionoptionalStringEnvironmentAccountRegionoptionalstringEnvironmentAccountRegionoptional*string#
The AWS Region in which an environment exists.
environmentBlueprintIdentifieroptionalstringenvironment_blueprint_identifieroptionalstrenvironmentBlueprintIdentifieroptionalStringEnvironmentBlueprintIdentifieroptionalstringEnvironmentBlueprintIdentifieroptional*string#
The identifier of the environment blueprint.
environmentConfigurationIdoptionalstringenvironment_configuration_idoptionalstrenvironmentConfigurationIdoptionalStringEnvironmentConfigurationIdoptionalstringEnvironmentConfigurationIdoptional*string#
The identifier of the environment configuration.
environmentProfileIdentifieroptionalstringenvironment_profile_identifieroptionalstrenvironmentProfileIdentifieroptionalStringEnvironmentProfileIdentifieroptionalstringEnvironmentProfileIdentifieroptional*string#
The identifier of the environment profile that is used to create this Amazon DataZone environment.
environmentRoleArnoptionalstringenvironment_role_arnoptionalstrenvironmentRoleArnoptionalStringEnvironmentRoleArnoptionalstringEnvironmentRoleArnoptional*string#
The ARN of the environment role.
glossaryTermsoptionalstring[]glossary_termsoptionaltyping.List[str]glossaryTermsoptionalList<String>GlossaryTermsoptionalstring[]GlossaryTermsoptional*[]*string#
The glossary terms that can be used in this Amazon DataZone environment.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the Amazon DataZone environment.
projectIdentifierstringproject_identifierstrprojectIdentifierStringProjectIdentifierstringProjectIdentifier*stringrequired#
The identifier of the Amazon DataZone project in which this environment is created.
userParametersoptionalIResolvable | IResolvable | CfnEnvironment.EnvironmentParameterProperty[]user_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EnvironmentParameterProperty]]]userParametersoptionalIResolvableUserParametersoptionalIResolvableUserParametersoptionalinterface{}#
The user parameters of this Amazon DataZone environment.