Package software.amazon.awscdk.services.datazone

Interface CfnEnvironmentProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:14.494Z")
@Stability(Stable)
public interface CfnEnvironmentProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEnvironmentProfile.

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.*;
 CfnEnvironmentProfileProps cfnEnvironmentProfileProps = CfnEnvironmentProfileProps.builder()
         .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	Interface	Description
static final class	CfnEnvironmentProfileProps.Builder	A builder for CfnEnvironmentProfileProps
static final class	CfnEnvironmentProfileProps.Jsii$Proxy	An implementation for CfnEnvironmentProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProfileProps.Builder	builder()
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.
default 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.
default Object	getUserParameters()	The user parameters of this Amazon DataZone environment profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

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

See Also:

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

getAwsAccountRegion

@Stability(Stable)
@NotNull
String getAwsAccountRegion()

The AWS Region in which an environment profile exists.

See Also:

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

getDomainIdentifier

@Stability(Stable)
@NotNull
String getDomainIdentifier()

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

See Also:

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

getEnvironmentBlueprintIdentifier

@Stability(Stable)
@NotNull
String getEnvironmentBlueprintIdentifier()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the environment profile.

See Also:

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

getProjectIdentifier

@Stability(Stable)
@NotNull
String getProjectIdentifier()

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

See Also:

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

getDescription

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

The description of the environment profile.

See Also:

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

getUserParameters

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

The user parameters of this Amazon DataZone environment profile.

See Also:

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

builder

@Stability(Stable)
static CfnEnvironmentProfileProps.Builder builder()

Returns:

a CfnEnvironmentProfileProps.Builder of CfnEnvironmentProfileProps