apihub

package
v8.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiHubInstance 

type ApiHubInstance struct {
	pulumi.CustomResourceState

	// Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field
	// is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are
	// '/a-z[0-9]-_/'.
	ApiHubInstanceId pulumi.StringPtrOutput `pulumi:"apiHubInstanceId"`
	// Available configurations to provision an ApiHub Instance.
	// Structure is documented below.
	Config ApiHubInstanceConfigOutput `pulumi:"config"`
	// Output only. Creation timestamp.
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// Optional. Description of the ApiHub instance.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
	EffectiveLabels pulumi.StringMapOutput `pulumi:"effectiveLabels"`
	// Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources **Note**: This field is non-authoritative, and will only manage
	// the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on
	// the resource.
	Labels pulumi.StringMapOutput `pulumi:"labels"`
	// Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
	Location pulumi.StringOutput `pulumi:"location"`
	// Identifier. Format:
	// `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// The combination of labels configured directly on the resource
	// and default labels configured on the provider.
	PulumiLabels pulumi.StringMapOutput `pulumi:"pulumiLabels"`
	// Output only. The current state of the ApiHub instance.
	// Possible values:
	// STATE_UNSPECIFIED
	// INACTIVE
	// CREATING
	// ACTIVE
	// UPDATING
	// DELETING
	// FAILED
	State pulumi.StringOutput `pulumi:"state"`
	// Output only. Extra information about ApiHub instance state. Currently the message
	// would be populated when state is `FAILED`.
	StateMessage pulumi.StringOutput `pulumi:"stateMessage"`
	// Output only. Last update timestamp.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. Currently, updation/deletion of ApiHub instance is not allowed.

## Example Usage

### Apihub Api Hub Instance Basic

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apihub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apihub.NewApiHubInstance(ctx, "apihub-instance-without-search", &apihub.ApiHubInstanceArgs{
			Location: pulumi.String("us-central1"),
			Config: &apihub.ApiHubInstanceConfigArgs{
				DisableSearch: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Apihub Api Hub Instance Full

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apihub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apihub.NewApiHubInstance(ctx, "apihub-instance-search", &apihub.ApiHubInstanceArgs{
			Project:          pulumi.String("my-project"),
			ApiHubInstanceId: pulumi.String("test-instance-full"),
			Description:      pulumi.String("Test API hub instance"),
			Location:         pulumi.String("us-central1"),
			Config: &apihub.ApiHubInstanceConfigArgs{
				EncryptionType: pulumi.String("CMEK"),
				CmekKeyName:    pulumi.String("projects/my-project/locations/us-central1/keyRings/apihub/cryptoKeys/apihub-key"),
				DisableSearch:  pulumi.Bool(false),
				VertexLocation: pulumi.String("us"),
			},
			Labels: pulumi.StringMap{
				"environment": pulumi.String("dev"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

ApiHubInstance can be imported using any of these accepted formats:

* `projects/{{project}}/locations/{{location}}/apiHubInstances/{{api_hub_instance_id}}`

* `{{project}}/{{location}}/{{api_hub_instance_id}}`

* `{{location}}/{{api_hub_instance_id}}`

When using the `pulumi import` command, ApiHubInstance can be imported using one of the formats above. For example:

```sh $ pulumi import gcp:apihub/apiHubInstance:ApiHubInstance default projects/{{project}}/locations/{{location}}/apiHubInstances/{{api_hub_instance_id}} ```

```sh $ pulumi import gcp:apihub/apiHubInstance:ApiHubInstance default {{project}}/{{location}}/{{api_hub_instance_id}} ```

```sh $ pulumi import gcp:apihub/apiHubInstance:ApiHubInstance default {{location}}/{{api_hub_instance_id}} ```

func GetApiHubInstance 

func GetApiHubInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ApiHubInstanceState, opts ...pulumi.ResourceOption) (*ApiHubInstance, error)

GetApiHubInstance gets an existing ApiHubInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApiHubInstance 

func NewApiHubInstance(ctx *pulumi.Context,
	name string, args *ApiHubInstanceArgs, opts ...pulumi.ResourceOption) (*ApiHubInstance, error)

NewApiHubInstance registers a new resource with the given unique name, arguments, and options.

func (*ApiHubInstance) ElementType 

func (*ApiHubInstance) ElementType() reflect.Type

func (*ApiHubInstance) ToApiHubInstanceOutput 

func (i *ApiHubInstance) ToApiHubInstanceOutput() ApiHubInstanceOutput

func (*ApiHubInstance) ToApiHubInstanceOutputWithContext 

func (i *ApiHubInstance) ToApiHubInstanceOutputWithContext(ctx context.Context) ApiHubInstanceOutput

type ApiHubInstanceArgs 

type ApiHubInstanceArgs struct {
	// Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field
	// is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are
	// '/a-z[0-9]-_/'.
	ApiHubInstanceId pulumi.StringPtrInput
	// Available configurations to provision an ApiHub Instance.
	// Structure is documented below.
	Config ApiHubInstanceConfigInput
	// Optional. Description of the ApiHub instance.
	Description pulumi.StringPtrInput
	// Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources **Note**: This field is non-authoritative, and will only manage
	// the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on
	// the resource.
	Labels pulumi.StringMapInput
	// Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
	Location pulumi.StringInput
	Project  pulumi.StringPtrInput
}

The set of arguments for constructing a ApiHubInstance resource.

func (ApiHubInstanceArgs) ElementType 

func (ApiHubInstanceArgs) ElementType() reflect.Type

type ApiHubInstanceArray 

type ApiHubInstanceArray []ApiHubInstanceInput

func (ApiHubInstanceArray) ElementType 

func (ApiHubInstanceArray) ElementType() reflect.Type

func (ApiHubInstanceArray) ToApiHubInstanceArrayOutput 

func (i ApiHubInstanceArray) ToApiHubInstanceArrayOutput() ApiHubInstanceArrayOutput

func (ApiHubInstanceArray) ToApiHubInstanceArrayOutputWithContext 

func (i ApiHubInstanceArray) ToApiHubInstanceArrayOutputWithContext(ctx context.Context) ApiHubInstanceArrayOutput

type ApiHubInstanceArrayInput 

type ApiHubInstanceArrayInput interface {
	pulumi.Input

	ToApiHubInstanceArrayOutput() ApiHubInstanceArrayOutput
	ToApiHubInstanceArrayOutputWithContext(context.Context) ApiHubInstanceArrayOutput
}

ApiHubInstanceArrayInput is an input type that accepts ApiHubInstanceArray and ApiHubInstanceArrayOutput values. You can construct a concrete instance of `ApiHubInstanceArrayInput` via: 

ApiHubInstanceArray{ ApiHubInstanceArgs{...} }

type ApiHubInstanceArrayOutput 

type ApiHubInstanceArrayOutput struct{ *pulumi.OutputState }

func (ApiHubInstanceArrayOutput) ElementType 

func (ApiHubInstanceArrayOutput) ElementType() reflect.Type

func (ApiHubInstanceArrayOutput) Index 

func (o ApiHubInstanceArrayOutput) Index(i pulumi.IntInput) ApiHubInstanceOutput

func (ApiHubInstanceArrayOutput) ToApiHubInstanceArrayOutput 

func (o ApiHubInstanceArrayOutput) ToApiHubInstanceArrayOutput() ApiHubInstanceArrayOutput

func (ApiHubInstanceArrayOutput) ToApiHubInstanceArrayOutputWithContext 

func (o ApiHubInstanceArrayOutput) ToApiHubInstanceArrayOutputWithContext(ctx context.Context) ApiHubInstanceArrayOutput

type ApiHubInstanceConfig 

type ApiHubInstanceConfig struct {
	// Optional. The Customer Managed Encryption Key (CMEK) used for data encryption.
	// The CMEK name should follow the format of
	// `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
	// where the location must match the instance location.
	// If the CMEK is not provided, a GMEK will be created for the instance.
	CmekKeyName *string `pulumi:"cmekKeyName"`
	// Optional. If true, the search will be disabled for the instance. The default value
	// is false.
	DisableSearch *bool `pulumi:"disableSearch"`
	// Optional. Encryption type for the region. If the encryption type is CMEK, the
	// cmekKeyName must be provided. If no encryption type is provided,
	// GMEK will be used.
	// Possible values:
	// ENCRYPTION_TYPE_UNSPECIFIED
	// GMEK
	// CMEK
	EncryptionType *string `pulumi:"encryptionType"`
	// Optional. The name of the Vertex AI location where the data store is stored.
	//
	// ***
	VertexLocation *string `pulumi:"vertexLocation"`
}

type ApiHubInstanceConfigArgs 

type ApiHubInstanceConfigArgs struct {
	// Optional. The Customer Managed Encryption Key (CMEK) used for data encryption.
	// The CMEK name should follow the format of
	// `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
	// where the location must match the instance location.
	// If the CMEK is not provided, a GMEK will be created for the instance.
	CmekKeyName pulumi.StringPtrInput `pulumi:"cmekKeyName"`
	// Optional. If true, the search will be disabled for the instance. The default value
	// is false.
	DisableSearch pulumi.BoolPtrInput `pulumi:"disableSearch"`
	// Optional. Encryption type for the region. If the encryption type is CMEK, the
	// cmekKeyName must be provided. If no encryption type is provided,
	// GMEK will be used.
	// Possible values:
	// ENCRYPTION_TYPE_UNSPECIFIED
	// GMEK
	// CMEK
	EncryptionType pulumi.StringPtrInput `pulumi:"encryptionType"`
	// Optional. The name of the Vertex AI location where the data store is stored.
	//
	// ***
	VertexLocation pulumi.StringPtrInput `pulumi:"vertexLocation"`
}

func (ApiHubInstanceConfigArgs) ElementType 

func (ApiHubInstanceConfigArgs) ElementType() reflect.Type

func (ApiHubInstanceConfigArgs) ToApiHubInstanceConfigOutput 

func (i ApiHubInstanceConfigArgs) ToApiHubInstanceConfigOutput() ApiHubInstanceConfigOutput

func (ApiHubInstanceConfigArgs) ToApiHubInstanceConfigOutputWithContext 

func (i ApiHubInstanceConfigArgs) ToApiHubInstanceConfigOutputWithContext(ctx context.Context) ApiHubInstanceConfigOutput

func (ApiHubInstanceConfigArgs) ToApiHubInstanceConfigPtrOutput 

func (i ApiHubInstanceConfigArgs) ToApiHubInstanceConfigPtrOutput() ApiHubInstanceConfigPtrOutput

func (ApiHubInstanceConfigArgs) ToApiHubInstanceConfigPtrOutputWithContext 

func (i ApiHubInstanceConfigArgs) ToApiHubInstanceConfigPtrOutputWithContext(ctx context.Context) ApiHubInstanceConfigPtrOutput

type ApiHubInstanceConfigInput 

type ApiHubInstanceConfigInput interface {
	pulumi.Input

	ToApiHubInstanceConfigOutput() ApiHubInstanceConfigOutput
	ToApiHubInstanceConfigOutputWithContext(context.Context) ApiHubInstanceConfigOutput
}

ApiHubInstanceConfigInput is an input type that accepts ApiHubInstanceConfigArgs and ApiHubInstanceConfigOutput values. You can construct a concrete instance of `ApiHubInstanceConfigInput` via: 

ApiHubInstanceConfigArgs{...}

type ApiHubInstanceConfigOutput 

type ApiHubInstanceConfigOutput struct{ *pulumi.OutputState }

func (ApiHubInstanceConfigOutput) CmekKeyName 

func (o ApiHubInstanceConfigOutput) CmekKeyName() pulumi.StringPtrOutput

Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.

func (ApiHubInstanceConfigOutput) DisableSearch 

func (o ApiHubInstanceConfigOutput) DisableSearch() pulumi.BoolPtrOutput

Optional. If true, the search will be disabled for the instance. The default value is false.

func (ApiHubInstanceConfigOutput) ElementType 

func (ApiHubInstanceConfigOutput) ElementType() reflect.Type

func (ApiHubInstanceConfigOutput) EncryptionType 

func (o ApiHubInstanceConfigOutput) EncryptionType() pulumi.StringPtrOutput

Optional. Encryption type for the region. If the encryption type is CMEK, the cmekKeyName must be provided. If no encryption type is provided, GMEK will be used. Possible values: ENCRYPTION_TYPE_UNSPECIFIED GMEK CMEK

func (ApiHubInstanceConfigOutput) ToApiHubInstanceConfigOutput 

func (o ApiHubInstanceConfigOutput) ToApiHubInstanceConfigOutput() ApiHubInstanceConfigOutput

func (ApiHubInstanceConfigOutput) ToApiHubInstanceConfigOutputWithContext 

func (o ApiHubInstanceConfigOutput) ToApiHubInstanceConfigOutputWithContext(ctx context.Context) ApiHubInstanceConfigOutput

func (ApiHubInstanceConfigOutput) ToApiHubInstanceConfigPtrOutput 

func (o ApiHubInstanceConfigOutput) ToApiHubInstanceConfigPtrOutput() ApiHubInstanceConfigPtrOutput

func (ApiHubInstanceConfigOutput) ToApiHubInstanceConfigPtrOutputWithContext 

func (o ApiHubInstanceConfigOutput) ToApiHubInstanceConfigPtrOutputWithContext(ctx context.Context) ApiHubInstanceConfigPtrOutput

func (ApiHubInstanceConfigOutput) VertexLocation 

func (o ApiHubInstanceConfigOutput) VertexLocation() pulumi.StringPtrOutput

Optional. The name of the Vertex AI location where the data store is stored.

***

type ApiHubInstanceConfigPtrInput 

type ApiHubInstanceConfigPtrInput interface {
	pulumi.Input

	ToApiHubInstanceConfigPtrOutput() ApiHubInstanceConfigPtrOutput
	ToApiHubInstanceConfigPtrOutputWithContext(context.Context) ApiHubInstanceConfigPtrOutput
}

ApiHubInstanceConfigPtrInput is an input type that accepts ApiHubInstanceConfigArgs, ApiHubInstanceConfigPtr and ApiHubInstanceConfigPtrOutput values. You can construct a concrete instance of `ApiHubInstanceConfigPtrInput` via: 

        ApiHubInstanceConfigArgs{...}

or:

        nil

func ApiHubInstanceConfigPtr 

func ApiHubInstanceConfigPtr(v *ApiHubInstanceConfigArgs) ApiHubInstanceConfigPtrInput

type ApiHubInstanceConfigPtrOutput 

type ApiHubInstanceConfigPtrOutput struct{ *pulumi.OutputState }

func (ApiHubInstanceConfigPtrOutput) CmekKeyName 

func (o ApiHubInstanceConfigPtrOutput) CmekKeyName() pulumi.StringPtrOutput

Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.

func (ApiHubInstanceConfigPtrOutput) DisableSearch 

func (o ApiHubInstanceConfigPtrOutput) DisableSearch() pulumi.BoolPtrOutput

Optional. If true, the search will be disabled for the instance. The default value is false.

func (ApiHubInstanceConfigPtrOutput) Elem 

func (o ApiHubInstanceConfigPtrOutput) Elem() ApiHubInstanceConfigOutput

func (ApiHubInstanceConfigPtrOutput) ElementType 

func (ApiHubInstanceConfigPtrOutput) ElementType() reflect.Type

func (ApiHubInstanceConfigPtrOutput) EncryptionType 

func (o ApiHubInstanceConfigPtrOutput) EncryptionType() pulumi.StringPtrOutput

Optional. Encryption type for the region. If the encryption type is CMEK, the cmekKeyName must be provided. If no encryption type is provided, GMEK will be used. Possible values: ENCRYPTION_TYPE_UNSPECIFIED GMEK CMEK

func (ApiHubInstanceConfigPtrOutput) ToApiHubInstanceConfigPtrOutput 

func (o ApiHubInstanceConfigPtrOutput) ToApiHubInstanceConfigPtrOutput() ApiHubInstanceConfigPtrOutput

func (ApiHubInstanceConfigPtrOutput) ToApiHubInstanceConfigPtrOutputWithContext 

func (o ApiHubInstanceConfigPtrOutput) ToApiHubInstanceConfigPtrOutputWithContext(ctx context.Context) ApiHubInstanceConfigPtrOutput

func (ApiHubInstanceConfigPtrOutput) VertexLocation 

func (o ApiHubInstanceConfigPtrOutput) VertexLocation() pulumi.StringPtrOutput

Optional. The name of the Vertex AI location where the data store is stored.

***

type ApiHubInstanceInput 

type ApiHubInstanceInput interface {
	pulumi.Input

	ToApiHubInstanceOutput() ApiHubInstanceOutput
	ToApiHubInstanceOutputWithContext(ctx context.Context) ApiHubInstanceOutput
}

type ApiHubInstanceMap 

type ApiHubInstanceMap map[string]ApiHubInstanceInput

func (ApiHubInstanceMap) ElementType 

func (ApiHubInstanceMap) ElementType() reflect.Type

func (ApiHubInstanceMap) ToApiHubInstanceMapOutput 

func (i ApiHubInstanceMap) ToApiHubInstanceMapOutput() ApiHubInstanceMapOutput

func (ApiHubInstanceMap) ToApiHubInstanceMapOutputWithContext 

func (i ApiHubInstanceMap) ToApiHubInstanceMapOutputWithContext(ctx context.Context) ApiHubInstanceMapOutput

type ApiHubInstanceMapInput 

type ApiHubInstanceMapInput interface {
	pulumi.Input

	ToApiHubInstanceMapOutput() ApiHubInstanceMapOutput
	ToApiHubInstanceMapOutputWithContext(context.Context) ApiHubInstanceMapOutput
}

ApiHubInstanceMapInput is an input type that accepts ApiHubInstanceMap and ApiHubInstanceMapOutput values. You can construct a concrete instance of `ApiHubInstanceMapInput` via: 

ApiHubInstanceMap{ "key": ApiHubInstanceArgs{...} }

type ApiHubInstanceMapOutput 

type ApiHubInstanceMapOutput struct{ *pulumi.OutputState }

func (ApiHubInstanceMapOutput) ElementType 

func (ApiHubInstanceMapOutput) ElementType() reflect.Type

func (ApiHubInstanceMapOutput) MapIndex 

func (o ApiHubInstanceMapOutput) MapIndex(k pulumi.StringInput) ApiHubInstanceOutput

func (ApiHubInstanceMapOutput) ToApiHubInstanceMapOutput 

func (o ApiHubInstanceMapOutput) ToApiHubInstanceMapOutput() ApiHubInstanceMapOutput

func (ApiHubInstanceMapOutput) ToApiHubInstanceMapOutputWithContext 

func (o ApiHubInstanceMapOutput) ToApiHubInstanceMapOutputWithContext(ctx context.Context) ApiHubInstanceMapOutput

type ApiHubInstanceOutput 

type ApiHubInstanceOutput struct{ *pulumi.OutputState }

func (ApiHubInstanceOutput) ApiHubInstanceId 

func (o ApiHubInstanceOutput) ApiHubInstanceId() pulumi.StringPtrOutput

Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are '/a-z[0-9]-_/'.

func (ApiHubInstanceOutput) Config 

func (o ApiHubInstanceOutput) Config() ApiHubInstanceConfigOutput

Available configurations to provision an ApiHub Instance. Structure is documented below.

func (ApiHubInstanceOutput) CreateTime 

func (o ApiHubInstanceOutput) CreateTime() pulumi.StringOutput

Output only. Creation timestamp.

func (ApiHubInstanceOutput) Description 

func (o ApiHubInstanceOutput) Description() pulumi.StringPtrOutput

Optional. Description of the ApiHub instance.

func (ApiHubInstanceOutput) EffectiveLabels 

func (o ApiHubInstanceOutput) EffectiveLabels() pulumi.StringMapOutput

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

func (ApiHubInstanceOutput) ElementType 

func (ApiHubInstanceOutput) ElementType() reflect.Type

func (ApiHubInstanceOutput) Labels 

func (o ApiHubInstanceOutput) Labels() pulumi.StringMapOutput

Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

func (ApiHubInstanceOutput) Location 

func (o ApiHubInstanceOutput) Location() pulumi.StringOutput

Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

func (ApiHubInstanceOutput) Name 

func (o ApiHubInstanceOutput) Name() pulumi.StringOutput

Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.

func (ApiHubInstanceOutput) Project 

func (o ApiHubInstanceOutput) Project() pulumi.StringOutput

func (ApiHubInstanceOutput) PulumiLabels 

func (o ApiHubInstanceOutput) PulumiLabels() pulumi.StringMapOutput

The combination of labels configured directly on the resource and default labels configured on the provider.

func (ApiHubInstanceOutput) State 

func (o ApiHubInstanceOutput) State() pulumi.StringOutput

Output only. The current state of the ApiHub instance. Possible values: STATE_UNSPECIFIED INACTIVE CREATING ACTIVE UPDATING DELETING FAILED

func (ApiHubInstanceOutput) StateMessage 

func (o ApiHubInstanceOutput) StateMessage() pulumi.StringOutput

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.

func (ApiHubInstanceOutput) ToApiHubInstanceOutput 

func (o ApiHubInstanceOutput) ToApiHubInstanceOutput() ApiHubInstanceOutput

func (ApiHubInstanceOutput) ToApiHubInstanceOutputWithContext 

func (o ApiHubInstanceOutput) ToApiHubInstanceOutputWithContext(ctx context.Context) ApiHubInstanceOutput

func (ApiHubInstanceOutput) UpdateTime 

func (o ApiHubInstanceOutput) UpdateTime() pulumi.StringOutput

Output only. Last update timestamp.

type ApiHubInstanceState 

type ApiHubInstanceState struct {
	// Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field
	// is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are
	// '/a-z[0-9]-_/'.
	ApiHubInstanceId pulumi.StringPtrInput
	// Available configurations to provision an ApiHub Instance.
	// Structure is documented below.
	Config ApiHubInstanceConfigPtrInput
	// Output only. Creation timestamp.
	CreateTime pulumi.StringPtrInput
	// Optional. Description of the ApiHub instance.
	Description pulumi.StringPtrInput
	// All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
	EffectiveLabels pulumi.StringMapInput
	// Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources **Note**: This field is non-authoritative, and will only manage
	// the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on
	// the resource.
	Labels pulumi.StringMapInput
	// Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
	Location pulumi.StringPtrInput
	// Identifier. Format:
	// `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
	// The combination of labels configured directly on the resource
	// and default labels configured on the provider.
	PulumiLabels pulumi.StringMapInput
	// Output only. The current state of the ApiHub instance.
	// Possible values:
	// STATE_UNSPECIFIED
	// INACTIVE
	// CREATING
	// ACTIVE
	// UPDATING
	// DELETING
	// FAILED
	State pulumi.StringPtrInput
	// Output only. Extra information about ApiHub instance state. Currently the message
	// would be populated when state is `FAILED`.
	StateMessage pulumi.StringPtrInput
	// Output only. Last update timestamp.
	UpdateTime pulumi.StringPtrInput
}

func (ApiHubInstanceState) ElementType 

func (ApiHubInstanceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.