Package software.amazon.awscdk.services.datazone

Class CfnEnvironmentBlueprintConfiguration

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.CfnEnvironmentBlueprintConfiguration
All Implemented Interfaces:
IInspectable, IEnvironmentBlueprintConfigurationRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.101Z") @Stability(Stable) public class CfnEnvironmentBlueprintConfiguration extends CfnResource implements IInspectable, IEnvironmentBlueprintConfigurationRef
The configuration details of an environment blueprint.

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.*;
 CfnEnvironmentBlueprintConfiguration cfnEnvironmentBlueprintConfiguration = CfnEnvironmentBlueprintConfiguration.Builder.create(this, "MyCfnEnvironmentBlueprintConfiguration")
         .domainIdentifier("domainIdentifier")
         .enabledRegions(List.of("enabledRegions"))
         .environmentBlueprintIdentifier("environmentBlueprintIdentifier")
         // the properties below are optional
         .environmentRolePermissionBoundary("environmentRolePermissionBoundary")
         .manageAccessRoleArn("manageAccessRoleArn")
         .provisioningConfigurations(List.of(ProvisioningConfigurationProperty.builder()
                 .lakeFormationConfiguration(LakeFormationConfigurationProperty.builder()
                         .locationRegistrationExcludeS3Locations(List.of("locationRegistrationExcludeS3Locations"))
                         .locationRegistrationRole("locationRegistrationRole")
                         .build())
                 .build()))
         .provisioningRoleArn("provisioningRoleArn")
         .regionalParameters(List.of(RegionalParameterProperty.builder()
                 .parameters(Map.of(
                         "parametersKey", "parameters"))
                 .region("region")
                 .build()))
         .build();

See Also:

  • 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

    • CfnEnvironmentBlueprintConfiguration

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

    • CfnEnvironmentBlueprintConfiguration

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

    • CfnEnvironmentBlueprintConfiguration

      @Stability(Stable) public CfnEnvironmentBlueprintConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEnvironmentBlueprintConfigurationProps props)
      Create a new AWS::DataZone::EnvironmentBlueprintConfiguration.

      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

    • isCfnEnvironmentBlueprintConfiguration

      @Stability(Stable) @NotNull public static Boolean isCfnEnvironmentBlueprintConfiguration(@NotNull Object x)
      Checks whether the given object is a CfnEnvironmentBlueprintConfiguration.

      Parameters:
      x - This parameter is required.

    • 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 blueprint was created.

    • getAttrDomainId

      @Stability(Stable) @NotNull public String getAttrDomainId()
      The identifier of the Amazon DataZone domain in which an environment blueprint exists.

    • getAttrEnvironmentBlueprintId

      @Stability(Stable) @NotNull public String getAttrEnvironmentBlueprintId()
      The identifier of the environment blueprint.

      This identifier should be used when creating environment profiles.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp of when the environment blueprint was updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEnvironmentBlueprintConfigurationRef

      @Stability(Stable) @NotNull public EnvironmentBlueprintConfigurationReference getEnvironmentBlueprintConfigurationRef()
      A reference to a EnvironmentBlueprintConfiguration resource.
      Specified by:
      getEnvironmentBlueprintConfigurationRef in interface IEnvironmentBlueprintConfigurationRef

    • getDomainIdentifier

      @Stability(Stable) @NotNull public String getDomainIdentifier()
      The identifier of the Amazon DataZone domain in which an environment blueprint exists.

    • setDomainIdentifier

      @Stability(Stable) public void setDomainIdentifier(@NotNull String value)
      The identifier of the Amazon DataZone domain in which an environment blueprint exists.

    • getEnabledRegions

      @Stability(Stable) @NotNull public List<String> getEnabledRegions()
      The enabled AWS Regions specified in a blueprint configuration.

    • setEnabledRegions

      @Stability(Stable) public void setEnabledRegions(@NotNull List<String> value)
      The enabled AWS Regions specified in a blueprint configuration.

    • getEnvironmentBlueprintIdentifier

      @Stability(Stable) @NotNull public String getEnvironmentBlueprintIdentifier()
      The identifier of the environment blueprint.

    • setEnvironmentBlueprintIdentifier

      @Stability(Stable) public void setEnvironmentBlueprintIdentifier(@NotNull String value)
      The identifier of the environment blueprint.

    • getEnvironmentRolePermissionBoundary

      @Stability(Stable) @Nullable public String getEnvironmentRolePermissionBoundary()
      The environment role permission boundary.

    • setEnvironmentRolePermissionBoundary

      @Stability(Stable) public void setEnvironmentRolePermissionBoundary(@Nullable String value)
      The environment role permission boundary.

    • getManageAccessRoleArn

      @Stability(Stable) @Nullable public String getManageAccessRoleArn()
      The ARN of the manage access role.

    • setManageAccessRoleArn

      @Stability(Stable) public void setManageAccessRoleArn(@Nullable String value)
      The ARN of the manage access role.

    • getProvisioningConfigurations

      @Stability(Stable) @Nullable public Object getProvisioningConfigurations()
      The provisioning configuration of a blueprint.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironmentBlueprintConfiguration.ProvisioningConfigurationProperty>

    • setProvisioningConfigurations

      @Stability(Stable) public void setProvisioningConfigurations(@Nullable IResolvable value)
      The provisioning configuration of a blueprint.

    • setProvisioningConfigurations

      @Stability(Stable) public void setProvisioningConfigurations(@Nullable List<Object> value)
      The provisioning configuration of a blueprint.

    • getProvisioningRoleArn

      @Stability(Stable) @Nullable public String getProvisioningRoleArn()
      The ARN of the provisioning role.

    • setProvisioningRoleArn

      @Stability(Stable) public void setProvisioningRoleArn(@Nullable String value)
      The ARN of the provisioning role.

    • getRegionalParameters

      @Stability(Stable) @Nullable public Object getRegionalParameters()
      The regional parameters of the environment blueprint.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironmentBlueprintConfiguration.RegionalParameterProperty>

    • setRegionalParameters

      @Stability(Stable) public void setRegionalParameters(@Nullable IResolvable value)
      The regional parameters of the environment blueprint.

    • setRegionalParameters

      @Stability(Stable) public void setRegionalParameters(@Nullable List<Object> value)
      The regional parameters of the environment blueprint.