Package software.amazon.awscdk.services.datazone

Class CfnEnvironmentProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.datazone.CfnEnvironmentProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:16.940Z")
@Stability(Stable)
public class CfnEnvironmentProfile
extends CfnResource
implements IInspectable

The details of an environment profile.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datazone.*;
 CfnEnvironmentProfile cfnEnvironmentProfile = CfnEnvironmentProfile.Builder.create(this, "MyCfnEnvironmentProfile")
         .awsAccountId("awsAccountId")
         .awsAccountRegion("awsAccountRegion")
         .domainIdentifier("domainIdentifier")
         .environmentBlueprintIdentifier("environmentBlueprintIdentifier")
         .name("name")
         .projectIdentifier("projectIdentifier")
         // the properties below are optional
         .description("description")
         .userParameters(List.of(EnvironmentParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEnvironmentProfile.Builder	A fluent builder for CfnEnvironmentProfile.
static interface	CfnEnvironmentProfile.EnvironmentParameterProperty	The parameter details of an environment profile.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEnvironmentProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironmentProfile(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEnvironmentProfile(software.constructs.Construct scope, String id, CfnEnvironmentProfileProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	The timestamp of when an environment profile was created.
String	getAttrCreatedBy()	The Amazon DataZone user who created the environment profile.
String	getAttrDomainId()	The identifier of the Amazon DataZone domain in which the environment profile exists.
String	getAttrEnvironmentBlueprintId()	The identifier of a blueprint with which an environment profile is created.
String	getAttrId()	The identifier of the environment profile.
String	getAttrProjectId()	The identifier of a project in which an environment profile exists.
String	getAttrUpdatedAt()	The timestamp of when the environment profile was updated.
String	getAwsAccountId()	The identifier of an AWS account in which an environment profile exists.
String	getAwsAccountRegion()	The AWS Region in which an environment profile exists.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the environment profile.
String	getDomainIdentifier()	The identifier of the Amazon DataZone domain in which the environment profile exists.
String	getEnvironmentBlueprintIdentifier()	The identifier of a blueprint with which an environment profile is created.
String	getName()	The name of the environment profile.
String	getProjectIdentifier()	The identifier of a project in which an environment profile exists.
Object	getUserParameters()	The user parameters of this Amazon DataZone environment profile.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value)	The identifier of an AWS account in which an environment profile exists.
void	setAwsAccountRegion(String value)	The AWS Region in which an environment profile exists.
void	setDescription(String value)	The description of the environment profile.
void	setDomainIdentifier(String value)	The identifier of the Amazon DataZone domain in which the environment profile exists.
void	setEnvironmentBlueprintIdentifier(String value)	The identifier of a blueprint with which an environment profile is created.
void	setName(String value)	The name of the environment profile.
void	setProjectIdentifier(String value)	The identifier of a project in which an environment profile exists.
void	setUserParameters(List<Object> value)	The user parameters of this Amazon DataZone environment profile.
void	setUserParameters(IResolvable value)	The user parameters of this Amazon DataZone environment profile.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnEnvironmentProfile

protected CfnEnvironmentProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnvironmentProfile

protected CfnEnvironmentProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnvironmentProfile

@Stability(Stable)
public CfnEnvironmentProfile(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEnvironmentProfileProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp of when an environment profile was created.

getAttrCreatedBy

@Stability(Stable)
@NotNull
public String getAttrCreatedBy()

The Amazon DataZone user who created the environment profile.

getAttrDomainId

@Stability(Stable)
@NotNull
public String getAttrDomainId()

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

getAttrEnvironmentBlueprintId

@Stability(Stable)
@NotNull
public String getAttrEnvironmentBlueprintId()

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

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The identifier of the environment profile.

getAttrProjectId

@Stability(Stable)
@NotNull
public String getAttrProjectId()

The identifier of a project in which an environment profile exists.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp of when the environment profile was updated.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAwsAccountId

@Stability(Stable)
@NotNull
public String getAwsAccountId()

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

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@NotNull
 String value)

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

getAwsAccountRegion

@Stability(Stable)
@NotNull
public String getAwsAccountRegion()

The AWS Region in which an environment profile exists.

setAwsAccountRegion

@Stability(Stable)
public void setAwsAccountRegion(@NotNull
 String value)

The AWS Region in which an environment profile exists.

getDomainIdentifier

@Stability(Stable)
@NotNull
public String getDomainIdentifier()

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

setDomainIdentifier

@Stability(Stable)
public void setDomainIdentifier(@NotNull
 String value)

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

getEnvironmentBlueprintIdentifier

@Stability(Stable)
@NotNull
public String getEnvironmentBlueprintIdentifier()

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

setEnvironmentBlueprintIdentifier

@Stability(Stable)
public void setEnvironmentBlueprintIdentifier(@NotNull
 String value)

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

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the environment profile.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the environment profile.

getProjectIdentifier

@Stability(Stable)
@NotNull
public String getProjectIdentifier()

The identifier of a project in which an environment profile exists.

setProjectIdentifier

@Stability(Stable)
public void setProjectIdentifier(@NotNull
 String value)

The identifier of a project in which an environment profile exists.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the environment profile.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the environment profile.

getUserParameters

@Stability(Stable)
@Nullable
public Object getUserParameters()

The user parameters of this Amazon DataZone environment profile.

setUserParameters

@Stability(Stable)
public void setUserParameters(@Nullable
 IResolvable value)

The user parameters of this Amazon DataZone environment profile.

setUserParameters

@Stability(Stable)
public void setUserParameters(@Nullable
 List<Object> value)

The user parameters of this Amazon DataZone environment profile.