Package com.hashicorp.cdktf.providers.google.vertex_ai_index_endpoint_deployed_index

Class VertexAiIndexEndpointDeployedIndex.Builder

    • Method Detail

      • connection

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

      • connection

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • deployedIndexId

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder deployedIndexId​(String deployedIndexId)
        The user specified ID of the DeployedIndex.

        The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#deployed_index_id VertexAiIndexEndpointDeployedIndex#deployed_index_id}

        Parameters:
        deployedIndexId - The user specified ID of the DeployedIndex. This parameter is required.
        Returns:
        this

      • index

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder index​(String index)
        The name of the Index this is the deployment of.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#index VertexAiIndexEndpointDeployedIndex#index}

        Parameters:
        index - The name of the Index this is the deployment of. This parameter is required.
        Returns:
        this

      • indexEndpoint

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder indexEndpoint​(String indexEndpoint)
        Identifies the index endpoint. Must be in the format 'projects/{{project}}/locations/{{region}}/indexEndpoints/{{indexEndpoint}}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#index_endpoint VertexAiIndexEndpointDeployedIndex#index_endpoint}

        Parameters:
        indexEndpoint - Identifies the index endpoint. Must be in the format 'projects/{{project}}/locations/{{region}}/indexEndpoints/{{indexEndpoint}}'. This parameter is required.
        Returns:
        this

      • automaticResources

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder automaticResources​(VertexAiIndexEndpointDeployedIndexAutomaticResources automaticResources)
        automatic_resources block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#automatic_resources VertexAiIndexEndpointDeployedIndex#automatic_resources}

        Parameters:
        automaticResources - automatic_resources block. This parameter is required.
        Returns:
        this

      • dedicatedResources

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder dedicatedResources​(VertexAiIndexEndpointDeployedIndexDedicatedResources dedicatedResources)
        dedicated_resources block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#dedicated_resources VertexAiIndexEndpointDeployedIndex#dedicated_resources}

        Parameters:
        dedicatedResources - dedicated_resources block. This parameter is required.
        Returns:
        this

      • deployedIndexAuthConfig

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder deployedIndexAuthConfig​(VertexAiIndexEndpointDeployedIndexDeployedIndexAuthConfig deployedIndexAuthConfig)
        deployed_index_auth_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#deployed_index_auth_config VertexAiIndexEndpointDeployedIndex#deployed_index_auth_config}

        Parameters:
        deployedIndexAuthConfig - deployed_index_auth_config block. This parameter is required.
        Returns:
        this

      • deploymentGroup

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder deploymentGroup​(String deploymentGroup)
        The deployment group can be no longer than 64 characters (eg: 'test', 'prod').

        If not set, we will use the 'default' deployment group. Creating deployment_groups with reserved_ip_ranges is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. [See the official documentation here](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints#DeployedIndex.FIELDS.deployment_group). Note: we only support up to 5 deployment groups (not including 'default'). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#deployment_group VertexAiIndexEndpointDeployedIndex#deployment_group}

        Parameters:
        deploymentGroup - The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder displayName​(String displayName)
        The display name of the Index.

        The name can be up to 128 characters long and can consist of any UTF-8 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#display_name VertexAiIndexEndpointDeployedIndex#display_name}

        Parameters:
        displayName - The display name of the Index. This parameter is required.
        Returns:
        this

      • enableAccessLogging

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder enableAccessLogging​(Boolean enableAccessLogging)
        If true, private endpoint's access logs are sent to Cloud Logging.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#enable_access_logging VertexAiIndexEndpointDeployedIndex#enable_access_logging}

        Parameters:
        enableAccessLogging - If true, private endpoint's access logs are sent to Cloud Logging. This parameter is required.
        Returns:
        this

      • enableAccessLogging

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder enableAccessLogging​(com.hashicorp.cdktf.IResolvable enableAccessLogging)
        If true, private endpoint's access logs are sent to Cloud Logging.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#enable_access_logging VertexAiIndexEndpointDeployedIndex#enable_access_logging}

        Parameters:
        enableAccessLogging - If true, private endpoint's access logs are sent to Cloud Logging. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#id VertexAiIndexEndpointDeployedIndex#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/vertex_ai_index_endpoint_deployed_index#id VertexAiIndexEndpointDeployedIndex#id}. This parameter is required.
        Returns:
        this

      • reservedIpRanges

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder reservedIpRanges​(List<String> reservedIpRanges)
        A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.

        If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/vertex_ai_index_endpoint_deployed_index#reserved_ip_ranges VertexAiIndexEndpointDeployedIndex#reserved_ip_ranges}

        Parameters:
        reservedIpRanges - A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndex.Builder timeouts​(VertexAiIndexEndpointDeployedIndexTimeouts timeouts)
        timeouts block.

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

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