Class AwsCodeBuildProjectEnvironment

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsCodeBuildProjectEnvironment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsCodeBuildProjectEnvironment.Builder,AwsCodeBuildProjectEnvironment>
@Generated("software.amazon.awssdk:codegen") public final class AwsCodeBuildProjectEnvironment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsCodeBuildProjectEnvironment.Builder,AwsCodeBuildProjectEnvironment>

Information about the build environment for this build project.

See Also:

  • Method Details

    • certificate

      public final String certificate()

      The certificate to use with this build project.

      Returns:
      The certificate to use with this build project.

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentVariables

      public final List<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables()

      A set of environment variables to make available to builds for the build project.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentVariables() method.

      Returns:
      A set of environment variables to make available to builds for the build project.

    • privilegedMode

      public final Boolean privilegedMode()

      Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

      Returns:
      Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

    • imagePullCredentialsType

      public final String imagePullCredentialsType()

      The type of credentials CodeBuild uses to pull images in your build.

      Valid values:

      • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.

      • SERVICE_ROLE specifies that CodeBuild uses your build project's service role.

      When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

      Returns:
      The type of credentials CodeBuild uses to pull images in your build.

      Valid values:

      • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.

      • SERVICE_ROLE specifies that CodeBuild uses your build project's service role.

      When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

    • registryCredential

      public final AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential()

      The credentials for access to a private registry.

      Returns:
      The credentials for access to a private registry.

    • type

      public final String type()

      The type of build environment to use for related builds.

      The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

      The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

      The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

      Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER

      Returns:
      The type of build environment to use for related builds.

      The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

      The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

      The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

      Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER

    • toBuilder

      public AwsCodeBuildProjectEnvironment.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsCodeBuildProjectEnvironment.Builder,AwsCodeBuildProjectEnvironment>
      Returns:
      a builder for type T

    • builder

      public static AwsCodeBuildProjectEnvironment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsCodeBuildProjectEnvironment.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.