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

Class VertexAiIndexEndpointDeployedIndexConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • deployedIndexId

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder deployedIndexId​(String deployedIndexId)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getDeployedIndexId()
        Parameters:
        deployedIndexId - The user specified ID of the DeployedIndex. This parameter is required. 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}
        Returns:
        this

      • indexEndpoint

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder indexEndpoint​(String indexEndpoint)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getIndexEndpoint()
        Parameters:
        indexEndpoint - Identifies the index endpoint. Must be in the format 'projects/{{project}}/locations/{{region}}/indexEndpoints/{{indexEndpoint}}'. This parameter is required. 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}
        Returns:
        this

      • deploymentGroup

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder deploymentGroup​(String deploymentGroup)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getDeploymentGroup()
        Parameters:
        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}
        Returns:
        this

      • displayName

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder displayName​(String displayName)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getDisplayName()
        Parameters:
        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}
        Returns:
        this

      • enableAccessLogging

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder enableAccessLogging​(com.hashicorp.cdktf.IResolvable enableAccessLogging)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getEnableAccessLogging()
        Parameters:
        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}
        Returns:
        this

      • id

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder id​(String id)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getId()
        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}. 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.
        Returns:
        this

      • reservedIpRanges

        @Stability(Stable)
public VertexAiIndexEndpointDeployedIndexConfig.Builder reservedIpRanges​(List<String> reservedIpRanges)
        Sets the value of VertexAiIndexEndpointDeployedIndexConfig.getReservedIpRanges()
        Parameters:
        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}
        Returns:
        this

      • connection

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public VertexAiIndexEndpointDeployedIndexConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this