Package software.amazon.awscdk.services.codebuild

Class CfnSandbox

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.codebuild.CfnSandbox
All Implemented Interfaces:
IInspectable, ISandboxRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:50:59.551Z") @Stability(Stable) public class CfnSandbox extends CfnResource implements IInspectable, ISandboxRef
Represents a CodeBuild sandbox, an ephemeral compute environment started from a CodeBuild project.

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.codebuild.*;
 CfnSandbox cfnSandbox = CfnSandbox.Builder.create(this, "MyCfnSandbox")
         .projectName("projectName")
         .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

    • CfnSandbox

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

    • CfnSandbox

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

    • CfnSandbox

      @Stability(Stable) public CfnSandbox(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnSandboxProps props)
      Create a new AWS::CodeBuild::Sandbox.

      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.

    • CfnSandbox

      @Stability(Stable) public CfnSandbox(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::CodeBuild::Sandbox.

      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.

  • Method Details

    • arnForSandbox

      @Stability(Stable) @NotNull public static String arnForSandbox(@NotNull ISandboxRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSandbox

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the sandbox.

    • getAttrEncryptionKey

      @Stability(Stable) @NotNull public String getAttrEncryptionKey()
      The KMS key used for encrypting the sandbox output artifacts.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the sandbox.

    • getAttrQueuedTimeoutInMinutes

      @Stability(Stable) @NotNull public Number getAttrQueuedTimeoutInMinutes()
      The number of minutes a sandbox is allowed to be queued before it times out.

    • getAttrRequestTime

      @Stability(Stable) @NotNull public String getAttrRequestTime()
      When the sandbox process was initially requested, expressed in ISO 8601 format.

    • getAttrServiceRole

      @Stability(Stable) @NotNull public String getAttrServiceRole()
      The name of a service role used for this sandbox.

    • getAttrStartTime

      @Stability(Stable) @NotNull public String getAttrStartTime()
      When the sandbox process started, expressed in ISO 8601 format.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the sandbox.

    • getAttrTimeoutInMinutes

      @Stability(Stable) @NotNull public Number getAttrTimeoutInMinutes()
      How long, in minutes, for CodeBuild to wait before timing out this sandbox.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getSandboxRef

      @Stability(Stable) @NotNull public SandboxReference getSandboxRef()
      A reference to a Sandbox resource.
      Specified by:
      getSandboxRef in interface ISandboxRef

    • getProjectName

      @Stability(Stable) @Nullable public String getProjectName()
      The CodeBuild project name.

    • setProjectName

      @Stability(Stable) public void setProjectName(@Nullable String value)
      The CodeBuild project name.