1. Packages
  2. Awx Provider
  3. API Docs
  4. InstanceGroup
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

awx.InstanceGroup

Explore with Pulumi AI

Create InstanceGroup Resource

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

Constructor syntax

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

@overload
def InstanceGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  instance_group_id: Optional[str] = None,
                  is_container_group: Optional[bool] = None,
                  name: Optional[str] = None,
                  pod_spec_override: Optional[str] = None,
                  policy_instance_minimum: Optional[float] = None,
                  policy_instance_percentage: Optional[float] = None)
func NewInstanceGroup(ctx *Context, name string, args *InstanceGroupArgs, opts ...ResourceOption) (*InstanceGroup, error)
public InstanceGroup(string name, InstanceGroupArgs? args = null, CustomResourceOptions? opts = null)
public InstanceGroup(String name, InstanceGroupArgs args)
public InstanceGroup(String name, InstanceGroupArgs args, CustomResourceOptions options)
type: awx:InstanceGroup
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 InstanceGroupArgs
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 InstanceGroupArgs
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 InstanceGroupArgs
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 InstanceGroupArgs
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. InstanceGroupArgs
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 instanceGroupResource = new Awx.InstanceGroup("instanceGroupResource", new()
{
    InstanceGroupId = "string",
    IsContainerGroup = false,
    Name = "string",
    PodSpecOverride = "string",
    PolicyInstanceMinimum = 0,
    PolicyInstancePercentage = 0,
});
Copy
example, err := awx.NewInstanceGroup(ctx, "instanceGroupResource", &awx.InstanceGroupArgs{
InstanceGroupId: pulumi.String("string"),
IsContainerGroup: pulumi.Bool(false),
Name: pulumi.String("string"),
PodSpecOverride: pulumi.String("string"),
PolicyInstanceMinimum: pulumi.Float64(0),
PolicyInstancePercentage: pulumi.Float64(0),
})
Copy
var instanceGroupResource = new InstanceGroup("instanceGroupResource", InstanceGroupArgs.builder()
    .instanceGroupId("string")
    .isContainerGroup(false)
    .name("string")
    .podSpecOverride("string")
    .policyInstanceMinimum(0)
    .policyInstancePercentage(0)
    .build());
Copy
instance_group_resource = awx.InstanceGroup("instanceGroupResource",
    instance_group_id="string",
    is_container_group=False,
    name="string",
    pod_spec_override="string",
    policy_instance_minimum=0,
    policy_instance_percentage=0)
Copy
const instanceGroupResource = new awx.InstanceGroup("instanceGroupResource", {
    instanceGroupId: "string",
    isContainerGroup: false,
    name: "string",
    podSpecOverride: "string",
    policyInstanceMinimum: 0,
    policyInstancePercentage: 0,
});
Copy
type: awx:InstanceGroup
properties:
    instanceGroupId: string
    isContainerGroup: false
    name: string
    podSpecOverride: string
    policyInstanceMinimum: 0
    policyInstancePercentage: 0
Copy

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

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing InstanceGroup Resource

Get an existing InstanceGroup 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?: InstanceGroupState, opts?: CustomResourceOptions): InstanceGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_group_id: Optional[str] = None,
        is_container_group: Optional[bool] = None,
        name: Optional[str] = None,
        pod_spec_override: Optional[str] = None,
        policy_instance_minimum: Optional[float] = None,
        policy_instance_percentage: Optional[float] = None) -> InstanceGroup
func GetInstanceGroup(ctx *Context, name string, id IDInput, state *InstanceGroupState, opts ...ResourceOption) (*InstanceGroup, error)
public static InstanceGroup Get(string name, Input<string> id, InstanceGroupState? state, CustomResourceOptions? opts = null)
public static InstanceGroup get(String name, Output<String> id, InstanceGroupState state, CustomResourceOptions options)
resources:  _:    type: awx:InstanceGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Package Details

Repository
awx denouche/terraform-provider-awx
License
Notes
This Pulumi package is based on the awx Terraform Provider.