Documentation
¶
Index ¶
- type Group
- type GroupArgs
- type GroupArray
- type GroupArrayInput
- type GroupArrayOutput
- type GroupInput
- type GroupMap
- type GroupMapInput
- type GroupMapOutput
- type GroupOutput
- func (o GroupOutput) CreateTime() pulumi.StringOutput
- func (o GroupOutput) Description() pulumi.StringPtrOutput
- func (o GroupOutput) DisplayName() pulumi.StringPtrOutput
- func (o GroupOutput) EffectiveLabels() pulumi.StringMapOutput
- func (GroupOutput) ElementType() reflect.Type
- func (o GroupOutput) GroupId() pulumi.StringOutput
- func (o GroupOutput) Labels() pulumi.StringMapOutput
- func (o GroupOutput) Location() pulumi.StringOutput
- func (o GroupOutput) Name() pulumi.StringOutput
- func (o GroupOutput) Project() pulumi.StringOutput
- func (o GroupOutput) PulumiLabels() pulumi.StringMapOutput
- func (o GroupOutput) ToGroupOutput() GroupOutput
- func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
- func (o GroupOutput) UpdateTime() pulumi.StringOutput
- type GroupState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Group ¶
type Group struct { pulumi.CustomResourceState // Output only. The timestamp when the group was created. CreateTime pulumi.StringOutput `pulumi:"createTime"` // Optional. The description of the group. Description pulumi.StringPtrOutput `pulumi:"description"` // Optional. User-friendly display name. DisplayName pulumi.StringPtrOutput `pulumi:"displayName"` // 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"` // Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`. // // *** GroupId pulumi.StringOutput `pulumi:"groupId"` // Labels as key value pairs. // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapOutput `pulumi:"labels"` // The location of the group. Location pulumi.StringOutput `pulumi:"location"` // Output only. The name of the group. Name pulumi.StringOutput `pulumi:"name"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. 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 timestamp when the group was last updated. UpdateTime pulumi.StringOutput `pulumi:"updateTime"` }
A resource that represents an asset group. The purpose of an asset group is to bundle a set of assets that have something in common, while allowing users to add annotations to the group.
## Example Usage ### Migration Group Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/migrationcenter" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := migrationcenter.NewGroup(ctx, "default", &migrationcenter.GroupArgs{ Description: pulumi.String("Terraform integration test description"), DisplayName: pulumi.String("Terraform integration test display"), GroupId: pulumi.String("group-test"), Labels: pulumi.StringMap{ "key": pulumi.String("value"), }, Location: pulumi.String("us-central1"), }) if err != nil { return err } return nil }) }
```
## Import
Group can be imported using any of these accepted formats:
`projects/{{project}}/locations/{{location}}/groups/{{group_id}}`
`{{project}}/{{location}}/{{group_id}}`
`{{location}}/{{group_id}}`
When using the `pulumi import` command, Group can be imported using one of the formats above. For example:
```sh $ pulumi import gcp:migrationcenter/group:Group default projects/{{project}}/locations/{{location}}/groups/{{group_id}} ```
```sh $ pulumi import gcp:migrationcenter/group:Group default {{project}}/{{location}}/{{group_id}} ```
```sh $ pulumi import gcp:migrationcenter/group:Group default {{location}}/{{group_id}} ```
func GetGroup ¶
func GetGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *GroupState, opts ...pulumi.ResourceOption) (*Group, error)
GetGroup gets an existing Group 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 NewGroup ¶
func NewGroup(ctx *pulumi.Context, name string, args *GroupArgs, opts ...pulumi.ResourceOption) (*Group, error)
NewGroup registers a new resource with the given unique name, arguments, and options.
func (*Group) ElementType ¶
func (*Group) ToGroupOutput ¶
func (i *Group) ToGroupOutput() GroupOutput
func (*Group) ToGroupOutputWithContext ¶
func (i *Group) ToGroupOutputWithContext(ctx context.Context) GroupOutput
type GroupArgs ¶
type GroupArgs struct { // Optional. The description of the group. Description pulumi.StringPtrInput // Optional. User-friendly display name. DisplayName pulumi.StringPtrInput // Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`. // // *** GroupId pulumi.StringInput // Labels as key value pairs. // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The location of the group. Location pulumi.StringInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
The set of arguments for constructing a Group resource.
func (GroupArgs) ElementType ¶
type GroupArray ¶
type GroupArray []GroupInput
func (GroupArray) ElementType ¶
func (GroupArray) ElementType() reflect.Type
func (GroupArray) ToGroupArrayOutput ¶
func (i GroupArray) ToGroupArrayOutput() GroupArrayOutput
func (GroupArray) ToGroupArrayOutputWithContext ¶
func (i GroupArray) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupArrayInput ¶
type GroupArrayInput interface { pulumi.Input ToGroupArrayOutput() GroupArrayOutput ToGroupArrayOutputWithContext(context.Context) GroupArrayOutput }
GroupArrayInput is an input type that accepts GroupArray and GroupArrayOutput values. You can construct a concrete instance of `GroupArrayInput` via:
GroupArray{ GroupArgs{...} }
type GroupArrayOutput ¶
type GroupArrayOutput struct{ *pulumi.OutputState }
func (GroupArrayOutput) ElementType ¶
func (GroupArrayOutput) ElementType() reflect.Type
func (GroupArrayOutput) Index ¶
func (o GroupArrayOutput) Index(i pulumi.IntInput) GroupOutput
func (GroupArrayOutput) ToGroupArrayOutput ¶
func (o GroupArrayOutput) ToGroupArrayOutput() GroupArrayOutput
func (GroupArrayOutput) ToGroupArrayOutputWithContext ¶
func (o GroupArrayOutput) ToGroupArrayOutputWithContext(ctx context.Context) GroupArrayOutput
type GroupInput ¶
type GroupInput interface { pulumi.Input ToGroupOutput() GroupOutput ToGroupOutputWithContext(ctx context.Context) GroupOutput }
type GroupMap ¶
type GroupMap map[string]GroupInput
func (GroupMap) ElementType ¶
func (GroupMap) ToGroupMapOutput ¶
func (i GroupMap) ToGroupMapOutput() GroupMapOutput
func (GroupMap) ToGroupMapOutputWithContext ¶
func (i GroupMap) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupMapInput ¶
type GroupMapInput interface { pulumi.Input ToGroupMapOutput() GroupMapOutput ToGroupMapOutputWithContext(context.Context) GroupMapOutput }
GroupMapInput is an input type that accepts GroupMap and GroupMapOutput values. You can construct a concrete instance of `GroupMapInput` via:
GroupMap{ "key": GroupArgs{...} }
type GroupMapOutput ¶
type GroupMapOutput struct{ *pulumi.OutputState }
func (GroupMapOutput) ElementType ¶
func (GroupMapOutput) ElementType() reflect.Type
func (GroupMapOutput) MapIndex ¶
func (o GroupMapOutput) MapIndex(k pulumi.StringInput) GroupOutput
func (GroupMapOutput) ToGroupMapOutput ¶
func (o GroupMapOutput) ToGroupMapOutput() GroupMapOutput
func (GroupMapOutput) ToGroupMapOutputWithContext ¶
func (o GroupMapOutput) ToGroupMapOutputWithContext(ctx context.Context) GroupMapOutput
type GroupOutput ¶
type GroupOutput struct{ *pulumi.OutputState }
func (GroupOutput) CreateTime ¶
func (o GroupOutput) CreateTime() pulumi.StringOutput
Output only. The timestamp when the group was created.
func (GroupOutput) Description ¶
func (o GroupOutput) Description() pulumi.StringPtrOutput
Optional. The description of the group.
func (GroupOutput) DisplayName ¶
func (o GroupOutput) DisplayName() pulumi.StringPtrOutput
Optional. User-friendly display name.
func (GroupOutput) EffectiveLabels ¶
func (o GroupOutput) 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 (GroupOutput) ElementType ¶
func (GroupOutput) ElementType() reflect.Type
func (GroupOutput) GroupId ¶
func (o GroupOutput) GroupId() pulumi.StringOutput
Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`.
***
func (GroupOutput) Labels ¶
func (o GroupOutput) Labels() pulumi.StringMapOutput
Labels as key value pairs. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effectiveLabels` for all of the labels present on the resource.
func (GroupOutput) Location ¶
func (o GroupOutput) Location() pulumi.StringOutput
The location of the group.
func (GroupOutput) Name ¶
func (o GroupOutput) Name() pulumi.StringOutput
Output only. The name of the group.
func (GroupOutput) Project ¶
func (o GroupOutput) Project() pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (GroupOutput) PulumiLabels ¶
func (o GroupOutput) PulumiLabels() pulumi.StringMapOutput
The combination of labels configured directly on the resource and default labels configured on the provider.
func (GroupOutput) ToGroupOutput ¶
func (o GroupOutput) ToGroupOutput() GroupOutput
func (GroupOutput) ToGroupOutputWithContext ¶
func (o GroupOutput) ToGroupOutputWithContext(ctx context.Context) GroupOutput
func (GroupOutput) UpdateTime ¶
func (o GroupOutput) UpdateTime() pulumi.StringOutput
Output only. The timestamp when the group was last updated.
type GroupState ¶
type GroupState struct { // Output only. The timestamp when the group was created. CreateTime pulumi.StringPtrInput // Optional. The description of the group. Description pulumi.StringPtrInput // Optional. User-friendly display name. DisplayName 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 // Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `a-z?`. // // *** GroupId pulumi.StringPtrInput // Labels as key value pairs. // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The location of the group. Location pulumi.StringPtrInput // Output only. The name of the group. Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. 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 timestamp when the group was last updated. UpdateTime pulumi.StringPtrInput }
func (GroupState) ElementType ¶
func (GroupState) ElementType() reflect.Type