We recommend new projects start with resources from the AWS provider.
aws-native.datazone.Environment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::DataZone::Environment Resource Type
Create Environment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain_identifier: Optional[str] = None,
                project_identifier: Optional[str] = None,
                description: Optional[str] = None,
                environment_account_identifier: Optional[str] = None,
                environment_account_region: Optional[str] = None,
                environment_profile_identifier: Optional[str] = None,
                environment_role_arn: Optional[str] = None,
                glossary_terms: Optional[Sequence[str]] = None,
                name: Optional[str] = None,
                user_parameters: Optional[Sequence[EnvironmentParameterArgs]] = None)func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: aws-native:datazone:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Environment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Environment resource accepts the following input properties:
- DomainIdentifier string
- The identifier of the Amazon DataZone domain in which the environment would be created.
- ProjectIdentifier string
- The ID of the Amazon DataZone project in which the environment would be created.
- Description string
- The description of the Amazon DataZone environment.
- EnvironmentAccount stringIdentifier 
- The AWS account in which the Amazon DataZone environment is created.
- EnvironmentAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- EnvironmentProfile stringIdentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- EnvironmentRole stringArn 
- Environment role arn for custom aws environment permissions
- GlossaryTerms List<string>
- The glossary terms that can be used in the Amazon DataZone environment.
- Name string
- The name of the environment.
- UserParameters List<Pulumi.Aws Native. Data Zone. Inputs. Environment Parameter> 
- The user parameters of the Amazon DataZone environment.
- DomainIdentifier string
- The identifier of the Amazon DataZone domain in which the environment would be created.
- ProjectIdentifier string
- The ID of the Amazon DataZone project in which the environment would be created.
- Description string
- The description of the Amazon DataZone environment.
- EnvironmentAccount stringIdentifier 
- The AWS account in which the Amazon DataZone environment is created.
- EnvironmentAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- EnvironmentProfile stringIdentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- EnvironmentRole stringArn 
- Environment role arn for custom aws environment permissions
- GlossaryTerms []string
- The glossary terms that can be used in the Amazon DataZone environment.
- Name string
- The name of the environment.
- UserParameters []EnvironmentParameter Args 
- The user parameters of the Amazon DataZone environment.
- domainIdentifier String
- The identifier of the Amazon DataZone domain in which the environment would be created.
- projectIdentifier String
- The ID of the Amazon DataZone project in which the environment would be created.
- description String
- The description of the Amazon DataZone environment.
- environmentAccount StringIdentifier 
- The AWS account in which the Amazon DataZone environment is created.
- environmentAccount StringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- environmentProfile StringIdentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- environmentRole StringArn 
- Environment role arn for custom aws environment permissions
- glossaryTerms List<String>
- The glossary terms that can be used in the Amazon DataZone environment.
- name String
- The name of the environment.
- userParameters List<EnvironmentParameter> 
- The user parameters of the Amazon DataZone environment.
- domainIdentifier string
- The identifier of the Amazon DataZone domain in which the environment would be created.
- projectIdentifier string
- The ID of the Amazon DataZone project in which the environment would be created.
- description string
- The description of the Amazon DataZone environment.
- environmentAccount stringIdentifier 
- The AWS account in which the Amazon DataZone environment is created.
- environmentAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- environmentProfile stringIdentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- environmentRole stringArn 
- Environment role arn for custom aws environment permissions
- glossaryTerms string[]
- The glossary terms that can be used in the Amazon DataZone environment.
- name string
- The name of the environment.
- userParameters EnvironmentParameter[] 
- The user parameters of the Amazon DataZone environment.
- domain_identifier str
- The identifier of the Amazon DataZone domain in which the environment would be created.
- project_identifier str
- The ID of the Amazon DataZone project in which the environment would be created.
- description str
- The description of the Amazon DataZone environment.
- environment_account_ stridentifier 
- The AWS account in which the Amazon DataZone environment is created.
- environment_account_ strregion 
- The AWS region in which the Amazon DataZone environment is created.
- environment_profile_ stridentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- environment_role_ strarn 
- Environment role arn for custom aws environment permissions
- glossary_terms Sequence[str]
- The glossary terms that can be used in the Amazon DataZone environment.
- name str
- The name of the environment.
- user_parameters Sequence[EnvironmentParameter Args] 
- The user parameters of the Amazon DataZone environment.
- domainIdentifier String
- The identifier of the Amazon DataZone domain in which the environment would be created.
- projectIdentifier String
- The ID of the Amazon DataZone project in which the environment would be created.
- description String
- The description of the Amazon DataZone environment.
- environmentAccount StringIdentifier 
- The AWS account in which the Amazon DataZone environment is created.
- environmentAccount StringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- environmentProfile StringIdentifier 
- The ID of the environment profile with which the Amazon DataZone environment would be created.
- environmentRole StringArn 
- Environment role arn for custom aws environment permissions
- glossaryTerms List<String>
- The glossary terms that can be used in the Amazon DataZone environment.
- name String
- The name of the environment.
- userParameters List<Property Map>
- The user parameters of the Amazon DataZone environment.
Outputs
All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:
- AwsAccount stringId 
- The AWS account in which the Amazon DataZone environment is created.
- AwsAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- AwsId string
- The ID of the Amazon DataZone environment.
- CreatedAt string
- The timestamp of when the environment was created.
- CreatedBy string
- The Amazon DataZone user who created the environment.
- DomainId string
- The identifier of the Amazon DataZone domain in which the environment is created.
- EnvironmentBlueprint stringId 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- EnvironmentProfile stringId 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- ProjectId string
- The ID of the Amazon DataZone project in which the environment is created.
- Provider string
- The provider of the Amazon DataZone environment.
- Status
Pulumi.Aws Native. Data Zone. Environment Status 
- The status of the Amazon DataZone environment.
- UpdatedAt string
- The timestamp of when the environment was updated.
- AwsAccount stringId 
- The AWS account in which the Amazon DataZone environment is created.
- AwsAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- AwsId string
- The ID of the Amazon DataZone environment.
- CreatedAt string
- The timestamp of when the environment was created.
- CreatedBy string
- The Amazon DataZone user who created the environment.
- DomainId string
- The identifier of the Amazon DataZone domain in which the environment is created.
- EnvironmentBlueprint stringId 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- EnvironmentProfile stringId 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- ProjectId string
- The ID of the Amazon DataZone project in which the environment is created.
- Provider string
- The provider of the Amazon DataZone environment.
- Status
EnvironmentStatus 
- The status of the Amazon DataZone environment.
- UpdatedAt string
- The timestamp of when the environment was updated.
- awsAccount StringId 
- The AWS account in which the Amazon DataZone environment is created.
- awsAccount StringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- awsId String
- The ID of the Amazon DataZone environment.
- createdAt String
- The timestamp of when the environment was created.
- createdBy String
- The Amazon DataZone user who created the environment.
- domainId String
- The identifier of the Amazon DataZone domain in which the environment is created.
- environmentBlueprint StringId 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- environmentProfile StringId 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- id String
- The provider-assigned unique ID for this managed resource.
- projectId String
- The ID of the Amazon DataZone project in which the environment is created.
- provider String
- The provider of the Amazon DataZone environment.
- status
EnvironmentStatus 
- The status of the Amazon DataZone environment.
- updatedAt String
- The timestamp of when the environment was updated.
- awsAccount stringId 
- The AWS account in which the Amazon DataZone environment is created.
- awsAccount stringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- awsId string
- The ID of the Amazon DataZone environment.
- createdAt string
- The timestamp of when the environment was created.
- createdBy string
- The Amazon DataZone user who created the environment.
- domainId string
- The identifier of the Amazon DataZone domain in which the environment is created.
- environmentBlueprint stringId 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- environmentProfile stringId 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- id string
- The provider-assigned unique ID for this managed resource.
- projectId string
- The ID of the Amazon DataZone project in which the environment is created.
- provider string
- The provider of the Amazon DataZone environment.
- status
EnvironmentStatus 
- The status of the Amazon DataZone environment.
- updatedAt string
- The timestamp of when the environment was updated.
- aws_account_ strid 
- The AWS account in which the Amazon DataZone environment is created.
- aws_account_ strregion 
- The AWS region in which the Amazon DataZone environment is created.
- aws_id str
- The ID of the Amazon DataZone environment.
- created_at str
- The timestamp of when the environment was created.
- created_by str
- The Amazon DataZone user who created the environment.
- domain_id str
- The identifier of the Amazon DataZone domain in which the environment is created.
- environment_blueprint_ strid 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- environment_profile_ strid 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- id str
- The provider-assigned unique ID for this managed resource.
- project_id str
- The ID of the Amazon DataZone project in which the environment is created.
- provider str
- The provider of the Amazon DataZone environment.
- status
EnvironmentStatus 
- The status of the Amazon DataZone environment.
- updated_at str
- The timestamp of when the environment was updated.
- awsAccount StringId 
- The AWS account in which the Amazon DataZone environment is created.
- awsAccount StringRegion 
- The AWS region in which the Amazon DataZone environment is created.
- awsId String
- The ID of the Amazon DataZone environment.
- createdAt String
- The timestamp of when the environment was created.
- createdBy String
- The Amazon DataZone user who created the environment.
- domainId String
- The identifier of the Amazon DataZone domain in which the environment is created.
- environmentBlueprint StringId 
- The ID of the blueprint with which the Amazon DataZone environment was created.
- environmentProfile StringId 
- The ID of the environment profile with which the Amazon DataZone environment was created.
- id String
- The provider-assigned unique ID for this managed resource.
- projectId String
- The ID of the Amazon DataZone project in which the environment is created.
- provider String
- The provider of the Amazon DataZone environment.
- status "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "CREATE_FAILED" | "UPDATE_FAILED" | "DELETE_FAILED" | "VALIDATION_FAILED" | "SUSPENDED" | "DISABLED" | "EXPIRED" | "DELETED" | "INACCESSIBLE"
- The status of the Amazon DataZone environment.
- updatedAt String
- The timestamp of when the environment was updated.
Supporting Types
EnvironmentParameter, EnvironmentParameterArgs    
EnvironmentStatus, EnvironmentStatusArgs    
- Active
- ACTIVE
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- CreateFailed 
- CREATE_FAILED
- UpdateFailed 
- UPDATE_FAILED
- DeleteFailed 
- DELETE_FAILED
- ValidationFailed 
- VALIDATION_FAILED
- Suspended
- SUSPENDED
- Disabled
- DISABLED
- Expired
- EXPIRED
- Deleted
- DELETED
- Inaccessible
- INACCESSIBLE
- EnvironmentStatus Active 
- ACTIVE
- EnvironmentStatus Creating 
- CREATING
- EnvironmentStatus Updating 
- UPDATING
- EnvironmentStatus Deleting 
- DELETING
- EnvironmentStatus Create Failed 
- CREATE_FAILED
- EnvironmentStatus Update Failed 
- UPDATE_FAILED
- EnvironmentStatus Delete Failed 
- DELETE_FAILED
- EnvironmentStatus Validation Failed 
- VALIDATION_FAILED
- EnvironmentStatus Suspended 
- SUSPENDED
- EnvironmentStatus Disabled 
- DISABLED
- EnvironmentStatus Expired 
- EXPIRED
- EnvironmentStatus Deleted 
- DELETED
- EnvironmentStatus Inaccessible 
- INACCESSIBLE
- Active
- ACTIVE
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- CreateFailed 
- CREATE_FAILED
- UpdateFailed 
- UPDATE_FAILED
- DeleteFailed 
- DELETE_FAILED
- ValidationFailed 
- VALIDATION_FAILED
- Suspended
- SUSPENDED
- Disabled
- DISABLED
- Expired
- EXPIRED
- Deleted
- DELETED
- Inaccessible
- INACCESSIBLE
- Active
- ACTIVE
- Creating
- CREATING
- Updating
- UPDATING
- Deleting
- DELETING
- CreateFailed 
- CREATE_FAILED
- UpdateFailed 
- UPDATE_FAILED
- DeleteFailed 
- DELETE_FAILED
- ValidationFailed 
- VALIDATION_FAILED
- Suspended
- SUSPENDED
- Disabled
- DISABLED
- Expired
- EXPIRED
- Deleted
- DELETED
- Inaccessible
- INACCESSIBLE
- ACTIVE
- ACTIVE
- CREATING
- CREATING
- UPDATING
- UPDATING
- DELETING
- DELETING
- CREATE_FAILED
- CREATE_FAILED
- UPDATE_FAILED
- UPDATE_FAILED
- DELETE_FAILED
- DELETE_FAILED
- VALIDATION_FAILED
- VALIDATION_FAILED
- SUSPENDED
- SUSPENDED
- DISABLED
- DISABLED
- EXPIRED
- EXPIRED
- DELETED
- DELETED
- INACCESSIBLE
- INACCESSIBLE
- "ACTIVE"
- ACTIVE
- "CREATING"
- CREATING
- "UPDATING"
- UPDATING
- "DELETING"
- DELETING
- "CREATE_FAILED"
- CREATE_FAILED
- "UPDATE_FAILED"
- UPDATE_FAILED
- "DELETE_FAILED"
- DELETE_FAILED
- "VALIDATION_FAILED"
- VALIDATION_FAILED
- "SUSPENDED"
- SUSPENDED
- "DISABLED"
- DISABLED
- "EXPIRED"
- EXPIRED
- "DELETED"
- DELETED
- "INACCESSIBLE"
- INACCESSIBLE
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.