Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. vmmigration
  5. vmmigration/v1alpha1
  6. Group

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.vmmigration/v1alpha1.Group

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new Group in a given project and location. Auto-naming is currently not supported for this resource.

Create Group Resource

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

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_id: Optional[str] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          location: Optional[str] = None,
          migration_target_type: Optional[GroupMigrationTargetType] = None,
          project: Optional[str] = None,
          request_id: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: google-native:vmmigration/v1alpha1:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
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 examplegroupResourceResourceFromVmmigrationv1alpha1 = new GoogleNative.VMMigration.V1Alpha1.Group("examplegroupResourceResourceFromVmmigrationv1alpha1", new()
{
    GroupId = "string",
    Description = "string",
    DisplayName = "string",
    Location = "string",
    MigrationTargetType = GoogleNative.VMMigration.V1Alpha1.GroupMigrationTargetType.MigrationTargetTypeUnspecified,
    Project = "string",
    RequestId = "string",
});
Copy
example, err := vmmigrationv1alpha1.NewGroup(ctx, "examplegroupResourceResourceFromVmmigrationv1alpha1", &vmmigrationv1alpha1.GroupArgs{
	GroupId:             pulumi.String("string"),
	Description:         pulumi.String("string"),
	DisplayName:         pulumi.String("string"),
	Location:            pulumi.String("string"),
	MigrationTargetType: vmmigrationv1alpha1.GroupMigrationTargetTypeMigrationTargetTypeUnspecified,
	Project:             pulumi.String("string"),
	RequestId:           pulumi.String("string"),
})
Copy
var examplegroupResourceResourceFromVmmigrationv1alpha1 = new Group("examplegroupResourceResourceFromVmmigrationv1alpha1", GroupArgs.builder()
    .groupId("string")
    .description("string")
    .displayName("string")
    .location("string")
    .migrationTargetType("MIGRATION_TARGET_TYPE_UNSPECIFIED")
    .project("string")
    .requestId("string")
    .build());
Copy
examplegroup_resource_resource_from_vmmigrationv1alpha1 = google_native.vmmigration.v1alpha1.Group("examplegroupResourceResourceFromVmmigrationv1alpha1",
    group_id="string",
    description="string",
    display_name="string",
    location="string",
    migration_target_type=google_native.vmmigration.v1alpha1.GroupMigrationTargetType.MIGRATION_TARGET_TYPE_UNSPECIFIED,
    project="string",
    request_id="string")
Copy
const examplegroupResourceResourceFromVmmigrationv1alpha1 = new google_native.vmmigration.v1alpha1.Group("examplegroupResourceResourceFromVmmigrationv1alpha1", {
    groupId: "string",
    description: "string",
    displayName: "string",
    location: "string",
    migrationTargetType: google_native.vmmigration.v1alpha1.GroupMigrationTargetType.MigrationTargetTypeUnspecified,
    project: "string",
    requestId: "string",
});
Copy
type: google-native:vmmigration/v1alpha1:Group
properties:
    description: string
    displayName: string
    groupId: string
    location: string
    migrationTargetType: MIGRATION_TARGET_TYPE_UNSPECIFIED
    project: string
    requestId: string
Copy

Group 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 Group resource accepts the following input properties:

GroupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The group identifier.
Description string
User-provided description of the group.
DisplayName string
Display name is a user defined name for this group which can be updated.
Location Changes to this property will trigger replacement. string
MigrationTargetType Pulumi.GoogleNative.VMMigration.V1Alpha1.GroupMigrationTargetType
Immutable. The target type of this group.
Project Changes to this property will trigger replacement. string
RequestId string
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
GroupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The group identifier.
Description string
User-provided description of the group.
DisplayName string
Display name is a user defined name for this group which can be updated.
Location Changes to this property will trigger replacement. string
MigrationTargetType GroupMigrationTargetType
Immutable. The target type of this group.
Project Changes to this property will trigger replacement. string
RequestId string
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
groupId
This property is required.
Changes to this property will trigger replacement.
String
Required. The group identifier.
description String
User-provided description of the group.
displayName String
Display name is a user defined name for this group which can be updated.
location Changes to this property will trigger replacement. String
migrationTargetType GroupMigrationTargetType
Immutable. The target type of this group.
project Changes to this property will trigger replacement. String
requestId String
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
groupId
This property is required.
Changes to this property will trigger replacement.
string
Required. The group identifier.
description string
User-provided description of the group.
displayName string
Display name is a user defined name for this group which can be updated.
location Changes to this property will trigger replacement. string
migrationTargetType GroupMigrationTargetType
Immutable. The target type of this group.
project Changes to this property will trigger replacement. string
requestId string
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
group_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The group identifier.
description str
User-provided description of the group.
display_name str
Display name is a user defined name for this group which can be updated.
location Changes to this property will trigger replacement. str
migration_target_type GroupMigrationTargetType
Immutable. The target type of this group.
project Changes to this property will trigger replacement. str
request_id str
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
groupId
This property is required.
Changes to this property will trigger replacement.
String
Required. The group identifier.
description String
User-provided description of the group.
displayName String
Display name is a user defined name for this group which can be updated.
location Changes to this property will trigger replacement. String
migrationTargetType "MIGRATION_TARGET_TYPE_UNSPECIFIED" | "MIGRATION_TARGET_TYPE_GCE" | "MIGRATION_TARGET_TYPE_DISKS"
Immutable. The target type of this group.
project Changes to this property will trigger replacement. String
requestId String
A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Outputs

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

CreateTime string
The create time timestamp.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The Group name.
UpdateTime string
The update time timestamp.
CreateTime string
The create time timestamp.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The Group name.
UpdateTime string
The update time timestamp.
createTime String
The create time timestamp.
id String
The provider-assigned unique ID for this managed resource.
name String
The Group name.
updateTime String
The update time timestamp.
createTime string
The create time timestamp.
id string
The provider-assigned unique ID for this managed resource.
name string
The Group name.
updateTime string
The update time timestamp.
create_time str
The create time timestamp.
id str
The provider-assigned unique ID for this managed resource.
name str
The Group name.
update_time str
The update time timestamp.
createTime String
The create time timestamp.
id String
The provider-assigned unique ID for this managed resource.
name String
The Group name.
updateTime String
The update time timestamp.

Supporting Types

GroupMigrationTargetType
, GroupMigrationTargetTypeArgs

MigrationTargetTypeUnspecified
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
MigrationTargetTypeGce
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
MigrationTargetTypeDisks
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.
GroupMigrationTargetTypeMigrationTargetTypeUnspecified
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
GroupMigrationTargetTypeMigrationTargetTypeGce
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
GroupMigrationTargetTypeMigrationTargetTypeDisks
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.
MigrationTargetTypeUnspecified
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
MigrationTargetTypeGce
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
MigrationTargetTypeDisks
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.
MigrationTargetTypeUnspecified
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
MigrationTargetTypeGce
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
MigrationTargetTypeDisks
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.
MIGRATION_TARGET_TYPE_UNSPECIFIED
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
MIGRATION_TARGET_TYPE_GCE
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
MIGRATION_TARGET_TYPE_DISKS
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.
"MIGRATION_TARGET_TYPE_UNSPECIFIED"
MIGRATION_TARGET_TYPE_UNSPECIFIEDGroup type is not specified. This defaults to Compute Engine targets.
"MIGRATION_TARGET_TYPE_GCE"
MIGRATION_TARGET_TYPE_GCEAll MigratingVMs in the group must have Compute Engine targets.
"MIGRATION_TARGET_TYPE_DISKS"
MIGRATION_TARGET_TYPE_DISKSAll MigratingVMs in the group must have Compute Engine Disks targets.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native