Package com.hashicorp.cdktf.providers.google.apigee_environment

Class ApigeeEnvironment.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ApigeeEnvironment.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of ApigeeEnvironment.Builder.

      • connection

        @Stability(Experimental)
public ApigeeEnvironment.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public ApigeeEnvironment.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ApigeeEnvironment.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public ApigeeEnvironment.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public ApigeeEnvironment.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public ApigeeEnvironment.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public ApigeeEnvironment.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public ApigeeEnvironment.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ApigeeEnvironment.Builder name​(String name)
        The resource ID of the environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#name ApigeeEnvironment#name}

        Parameters:
        name - The resource ID of the environment. This parameter is required.
        Returns:
        this

      • orgId

        @Stability(Stable)
public ApigeeEnvironment.Builder orgId​(String orgId)
        The Apigee Organization associated with the Apigee environment, in the format 'organizations/{{org_name}}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#org_id ApigeeEnvironment#org_id}

        Parameters:
        orgId - The Apigee Organization associated with the Apigee environment, in the format 'organizations/{{org_name}}'. This parameter is required.
        Returns:
        this

      • apiProxyType

        @Stability(Stable)
public ApigeeEnvironment.Builder apiProxyType​(String apiProxyType)
        Optional.

        API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values: ["API_PROXY_TYPE_UNSPECIFIED", "PROGRAMMABLE", "CONFIGURABLE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#api_proxy_type ApigeeEnvironment#api_proxy_type}

        Parameters:
        apiProxyType - Optional. This parameter is required.
        Returns:
        this

      • deploymentType

        @Stability(Stable)
public ApigeeEnvironment.Builder deploymentType​(String deploymentType)
        Optional.

        Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values: ["DEPLOYMENT_TYPE_UNSPECIFIED", "PROXY", "ARCHIVE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#deployment_type ApigeeEnvironment#deployment_type}

        Parameters:
        deploymentType - Optional. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ApigeeEnvironment.Builder description​(String description)
        Description of the environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#description ApigeeEnvironment#description}

        Parameters:
        description - Description of the environment. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public ApigeeEnvironment.Builder displayName​(String displayName)
        Display name of the environment.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#display_name ApigeeEnvironment#display_name}

        Parameters:
        displayName - Display name of the environment. This parameter is required.
        Returns:
        this

      • forwardProxyUri

        @Stability(Stable)
public ApigeeEnvironment.Builder forwardProxyUri​(String forwardProxyUri)
        Optional.

        URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#forward_proxy_uri ApigeeEnvironment#forward_proxy_uri}

        Parameters:
        forwardProxyUri - Optional. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ApigeeEnvironment.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#id ApigeeEnvironment#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#id ApigeeEnvironment#id}. This parameter is required.
        Returns:
        this

      • nodeConfig

        @Stability(Stable)
public ApigeeEnvironment.Builder nodeConfig​(ApigeeEnvironmentNodeConfig nodeConfig)
        node_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#node_config ApigeeEnvironment#node_config}

        Parameters:
        nodeConfig - node_config block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ApigeeEnvironment.Builder timeouts​(ApigeeEnvironmentTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#timeouts ApigeeEnvironment#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public ApigeeEnvironment.Builder type​(String type)
        Types that can be selected for an Environment.

        Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values: ["ENVIRONMENT_TYPE_UNSPECIFIED", "BASE", "INTERMEDIATE", "COMPREHENSIVE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/apigee_environment#type ApigeeEnvironment#type}

        Parameters:
        type - Types that can be selected for an Environment. This parameter is required.
        Returns:
        this