konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.ApiProductVersion

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.ApiProductVersion;
import com.pulumi.konnect.ApiProductVersionArgs;
import com.pulumi.konnect.inputs.ApiProductVersionGatewayServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myApiproductversion = new ApiProductVersion("myApiproductversion", ApiProductVersionArgs.builder()
            .apiProductId("d32d905a-ed33-46a3-a093-d8f536af9a8a")
            .deprecated(false)
            .gatewayService(ApiProductVersionGatewayServiceArgs.builder()
                .control_plane_id("e4d9ebb1-26b4-426a-b00e-cb67044f3baf")
                .id("09b4786a-3e48-4631-8f6b-62d1d8e1a7f3")
                .build())
            .labels(Map.of("key", "value"))
            .build());

    }
}

resources:
  myApiproductversion:
    type: konnect:ApiProductVersion
    properties:
      apiProductId: d32d905a-ed33-46a3-a093-d8f536af9a8a
      deprecated: false
      gatewayService:
        control_plane_id: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
        id: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
      labels:
        key: value

Create ApiProductVersion Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiProductVersion(name: string, args: ApiProductVersionArgs, opts?: CustomResourceOptions);

@overload
def ApiProductVersion(resource_name: str,
                      args: ApiProductVersionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ApiProductVersion(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      api_product_id: Optional[str] = None,
                      deprecated: Optional[bool] = None,
                      gateway_service: Optional[ApiProductVersionGatewayServiceArgs] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      name: Optional[str] = None)

func NewApiProductVersion(ctx *Context, name string, args ApiProductVersionArgs, opts ...ResourceOption) (*ApiProductVersion, error)

public ApiProductVersion(string name, ApiProductVersionArgs args, CustomResourceOptions? opts = null)

public ApiProductVersion(String name, ApiProductVersionArgs args)
public ApiProductVersion(String name, ApiProductVersionArgs args, CustomResourceOptions options)

type: konnect:ApiProductVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ApiProductVersionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ApiProductVersionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ApiProductVersionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ApiProductVersionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ApiProductVersionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiProductVersionResource = new Konnect.ApiProductVersion("apiProductVersionResource", new()
{
    ApiProductId = "string",
    GatewayService = new Konnect.Inputs.ApiProductVersionGatewayServiceArgs
    {
        ControlPlaneId = "string",
        Id = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
});

example, err := konnect.NewApiProductVersion(ctx, "apiProductVersionResource", &konnect.ApiProductVersionArgs{
ApiProductId: pulumi.String("string"),
GatewayService: &.ApiProductVersionGatewayServiceArgs{
ControlPlaneId: pulumi.String("string"),
Id: pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
})

var apiProductVersionResource = new ApiProductVersion("apiProductVersionResource", ApiProductVersionArgs.builder()
    .apiProductId("string")
    .gatewayService(ApiProductVersionGatewayServiceArgs.builder()
        .controlPlaneId("string")
        .id("string")
        .build())
    .labels(Map.of("string", "string"))
    .name("string")
    .build());

api_product_version_resource = konnect.ApiProductVersion("apiProductVersionResource",
    api_product_id="string",
    gateway_service={
        "control_plane_id": "string",
        "id": "string",
    },
    labels={
        "string": "string",
    },
    name="string")

const apiProductVersionResource = new konnect.ApiProductVersion("apiProductVersionResource", {
    apiProductId: "string",
    gatewayService: {
        controlPlaneId: "string",
        id: "string",
    },
    labels: {
        string: "string",
    },
    name: "string",
});

type: konnect:ApiProductVersion
properties:
    apiProductId: string
    gatewayService:
        controlPlaneId: string
        id: string
    labels:
        string: string
    name: string

ApiProductVersion Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiProductVersion resource accepts the following input properties:

ApiProductId string: The API Product ID
Deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
GatewayService ApiProductVersionGatewayService
Labels Dictionary<string, string>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string: The version name of the API product version.

ApiProductId string: The API Product ID
Deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
GatewayService ApiProductVersionGatewayServiceArgs
Labels map[string]string: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string: The version name of the API product version.

apiProductId String: The API Product ID
deprecated Boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService ApiProductVersionGatewayService
labels Map<String,String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String: The version name of the API product version.

apiProductId string: The API Product ID
deprecated boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService ApiProductVersionGatewayService
labels {[key: string]: string}: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name string: The version name of the API product version.

api_product_id str: The API Product ID
deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gateway_service ApiProductVersionGatewayServiceArgs
labels Mapping[str, str]: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name str: The version name of the API product version.

apiProductId String: The API Product ID
deprecated Boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService Property Map
labels Map<String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String: The version name of the API product version.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiProductVersion resource produces the following output properties:

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Id string: The provider-assigned unique ID for this managed resource.
Portals List<ApiProductVersionPortal>: The list of portals which this API product version is configured for
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Id string: The provider-assigned unique ID for this managed resource.
Portals []ApiProductVersionPortal: The list of portals which this API product version is configured for
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
id String: The provider-assigned unique ID for this managed resource.
portals List<ApiProductVersionPortal>: The list of portals which this API product version is configured for
updatedAt String: An ISO-8601 timestamp representation of entity update date.

createdAt string: An ISO-8601 timestamp representation of entity creation date.
id string: The provider-assigned unique ID for this managed resource.
portals ApiProductVersionPortal[]: The list of portals which this API product version is configured for
updatedAt string: An ISO-8601 timestamp representation of entity update date.

created_at str: An ISO-8601 timestamp representation of entity creation date.
id str: The provider-assigned unique ID for this managed resource.
portals Sequence[ApiProductVersionPortal]: The list of portals which this API product version is configured for
updated_at str: An ISO-8601 timestamp representation of entity update date.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
id String: The provider-assigned unique ID for this managed resource.
portals List<Property Map>: The list of portals which this API product version is configured for
updatedAt String: An ISO-8601 timestamp representation of entity update date.

Look up Existing ApiProductVersion Resource

Get an existing ApiProductVersion resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiProductVersionState, opts?: CustomResourceOptions): ApiProductVersion

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_product_id: Optional[str] = None,
        created_at: Optional[str] = None,
        deprecated: Optional[bool] = None,
        gateway_service: Optional[ApiProductVersionGatewayServiceArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        portals: Optional[Sequence[ApiProductVersionPortalArgs]] = None,
        updated_at: Optional[str] = None) -> ApiProductVersion

func GetApiProductVersion(ctx *Context, name string, id IDInput, state *ApiProductVersionState, opts ...ResourceOption) (*ApiProductVersion, error)

public static ApiProductVersion Get(string name, Input<string> id, ApiProductVersionState? state, CustomResourceOptions? opts = null)

public static ApiProductVersion get(String name, Output<String> id, ApiProductVersionState state, CustomResourceOptions options)

resources:  _:    type: konnect:ApiProductVersion    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiProductId string: The API Product ID
CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
GatewayService ApiProductVersionGatewayService
Labels Dictionary<string, string>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string: The version name of the API product version.
Portals List<ApiProductVersionPortal>: The list of portals which this API product version is configured for
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

ApiProductId string: The API Product ID
CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
GatewayService ApiProductVersionGatewayServiceArgs
Labels map[string]string: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Name string: The version name of the API product version.
Portals []ApiProductVersionPortalArgs: The list of portals which this API product version is configured for
UpdatedAt string: An ISO-8601 timestamp representation of entity update date.

apiProductId String: The API Product ID
createdAt String: An ISO-8601 timestamp representation of entity creation date.
deprecated Boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService ApiProductVersionGatewayService
labels Map<String,String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String: The version name of the API product version.
portals List<ApiProductVersionPortal>: The list of portals which this API product version is configured for
updatedAt String: An ISO-8601 timestamp representation of entity update date.

apiProductId string: The API Product ID
createdAt string: An ISO-8601 timestamp representation of entity creation date.
deprecated boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService ApiProductVersionGatewayService
labels {[key: string]: string}: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name string: The version name of the API product version.
portals ApiProductVersionPortal[]: The list of portals which this API product version is configured for
updatedAt string: An ISO-8601 timestamp representation of entity update date.

api_product_id str: The API Product ID
created_at str: An ISO-8601 timestamp representation of entity creation date.
deprecated bool: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gateway_service ApiProductVersionGatewayServiceArgs
labels Mapping[str, str]: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name str: The version name of the API product version.
portals Sequence[ApiProductVersionPortalArgs]: The list of portals which this API product version is configured for
updated_at str: An ISO-8601 timestamp representation of entity update date.

apiProductId String: The API Product ID
createdAt String: An ISO-8601 timestamp representation of entity creation date.
deprecated Boolean: Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Deprecated: Deprecated
gatewayService Property Map
labels Map<String>: Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
name String: The version name of the API product version.
portals List<Property Map>: The list of portals which this API product version is configured for
updatedAt String: An ISO-8601 timestamp representation of entity update date.

Supporting Types

ApiProductVersionGatewayService, ApiProductVersionGatewayServiceArgs

ControlPlaneId string: The identifier of the control plane that the gateway service resides in. Not Null
Id string: The identifier of a gateway service associated with the version of the API product. Not Null
RuntimeGroupId string: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

ControlPlaneId string: The identifier of the control plane that the gateway service resides in. Not Null
Id string: The identifier of a gateway service associated with the version of the API product. Not Null
RuntimeGroupId string: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

controlPlaneId String: The identifier of the control plane that the gateway service resides in. Not Null
id String: The identifier of a gateway service associated with the version of the API product. Not Null
runtimeGroupId String: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

controlPlaneId string: The identifier of the control plane that the gateway service resides in. Not Null
id string: The identifier of a gateway service associated with the version of the API product. Not Null
runtimeGroupId string: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

control_plane_id str: The identifier of the control plane that the gateway service resides in. Not Null
id str: The identifier of a gateway service associated with the version of the API product. Not Null
runtime_group_id str: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

controlPlaneId String: The identifier of the control plane that the gateway service resides in. Not Null
id String: The identifier of a gateway service associated with the version of the API product. Not Null
runtimeGroupId String: This field is deprecated, please use control_plane_id instead. The identifier of the control plane that the gateway service resides in
Deprecated: Deprecated

ApiProductVersionPortal, ApiProductVersionPortalArgs

ApplicationRegistrationEnabled bool
AuthStrategies List<ApiProductVersionPortalAuthStrategy>
AutoApproveRegistration bool
Deprecated bool
PortalId string
PortalName string
PortalProductVersionId string
PublishStatus string: must be one of ["published", "unpublished"]

ApplicationRegistrationEnabled bool
AuthStrategies []ApiProductVersionPortalAuthStrategy
AutoApproveRegistration bool
Deprecated bool
PortalId string
PortalName string
PortalProductVersionId string
PublishStatus string: must be one of ["published", "unpublished"]

applicationRegistrationEnabled Boolean
authStrategies List<ApiProductVersionPortalAuthStrategy>
autoApproveRegistration Boolean
deprecated Boolean
portalId String
portalName String
portalProductVersionId String
publishStatus String: must be one of ["published", "unpublished"]

applicationRegistrationEnabled boolean
authStrategies ApiProductVersionPortalAuthStrategy[]
autoApproveRegistration boolean
deprecated boolean
portalId string
portalName string
portalProductVersionId string
publishStatus string: must be one of ["published", "unpublished"]

application_registration_enabled bool
auth_strategies Sequence[ApiProductVersionPortalAuthStrategy]
auto_approve_registration bool
deprecated bool
portal_id str
portal_name str
portal_product_version_id str
publish_status str: must be one of ["published", "unpublished"]

applicationRegistrationEnabled Boolean
authStrategies List<Property Map>
autoApproveRegistration Boolean
deprecated Boolean
portalId String
portalName String
portalProductVersionId String
publishStatus String: must be one of ["published", "unpublished"]

ApiProductVersionPortalAuthStrategy, ApiProductVersionPortalAuthStrategyArgs

Id string
Name string

Id string
Name string

id String
name String

id string
name string

id str
name str

id String
name String

Import

$ pulumi import konnect:index/apiProductVersion:ApiProductVersion my_konnect_api_product_version "{ \"api_product_id\": \"d32d905a-ed33-46a3-a093-d8f536af9a8a\", \"id\": \"9f5061ce-78f6-4452-9108-ad7c02821fd5\"}"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.ApiProductVersion

On this page

On this page

Example Usage

Create ApiProductVersion Resource

Constructor syntax

Parameters

Constructor example

ApiProductVersion Resource Properties

Inputs

Outputs

Look up Existing ApiProductVersion Resource

Supporting Types

ApiProductVersionGatewayService, ApiProductVersionGatewayServiceArgs

ApiProductVersionPortal, ApiProductVersionPortalArgs

ApiProductVersionPortalAuthStrategy, ApiProductVersionPortalAuthStrategyArgs

Import

Package Details

On this page

On this page