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

awx.InventorySource

Explore with Pulumi AI

TBD

Create InventorySource Resource

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

Constructor syntax

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

@overload
def InventorySource(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    inventory_id: Optional[float] = None,
                    overwrite: Optional[bool] = None,
                    overwrite_vars: Optional[bool] = None,
                    enabled_var: Optional[str] = None,
                    credential_id: Optional[float] = None,
                    host_filter: Optional[str] = None,
                    instance_filters: Optional[str] = None,
                    description: Optional[str] = None,
                    inventory_source_id: Optional[str] = None,
                    enabled_value: Optional[str] = None,
                    name: Optional[str] = None,
                    group_by: Optional[str] = None,
                    source: Optional[str] = None,
                    source_path: Optional[str] = None,
                    source_project_id: Optional[float] = None,
                    source_regions: Optional[str] = None,
                    source_vars: Optional[str] = None,
                    update_cache_timeout: Optional[float] = None,
                    update_on_launch: Optional[bool] = None,
                    verbosity: Optional[float] = None)
func NewInventorySource(ctx *Context, name string, args InventorySourceArgs, opts ...ResourceOption) (*InventorySource, error)
public InventorySource(string name, InventorySourceArgs args, CustomResourceOptions? opts = null)
public InventorySource(String name, InventorySourceArgs args)
public InventorySource(String name, InventorySourceArgs args, CustomResourceOptions options)
type: awx:InventorySource
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. InventorySourceArgs
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. InventorySourceArgs
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. InventorySourceArgs
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. InventorySourceArgs
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. InventorySourceArgs
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 inventorySourceResource = new Awx.InventorySource("inventorySourceResource", new()
{
    InventoryId = 0,
    Overwrite = false,
    OverwriteVars = false,
    EnabledVar = "string",
    CredentialId = 0,
    HostFilter = "string",
    InstanceFilters = "string",
    Description = "string",
    InventorySourceId = "string",
    EnabledValue = "string",
    Name = "string",
    GroupBy = "string",
    Source = "string",
    SourcePath = "string",
    SourceProjectId = 0,
    SourceRegions = "string",
    SourceVars = "string",
    UpdateCacheTimeout = 0,
    UpdateOnLaunch = false,
    Verbosity = 0,
});
Copy
example, err := awx.NewInventorySource(ctx, "inventorySourceResource", &awx.InventorySourceArgs{
InventoryId: pulumi.Float64(0),
Overwrite: pulumi.Bool(false),
OverwriteVars: pulumi.Bool(false),
EnabledVar: pulumi.String("string"),
CredentialId: pulumi.Float64(0),
HostFilter: pulumi.String("string"),
InstanceFilters: pulumi.String("string"),
Description: pulumi.String("string"),
InventorySourceId: pulumi.String("string"),
EnabledValue: pulumi.String("string"),
Name: pulumi.String("string"),
GroupBy: pulumi.String("string"),
Source: pulumi.String("string"),
SourcePath: pulumi.String("string"),
SourceProjectId: pulumi.Float64(0),
SourceRegions: pulumi.String("string"),
SourceVars: pulumi.String("string"),
UpdateCacheTimeout: pulumi.Float64(0),
UpdateOnLaunch: pulumi.Bool(false),
Verbosity: pulumi.Float64(0),
})
Copy
var inventorySourceResource = new InventorySource("inventorySourceResource", InventorySourceArgs.builder()
    .inventoryId(0)
    .overwrite(false)
    .overwriteVars(false)
    .enabledVar("string")
    .credentialId(0)
    .hostFilter("string")
    .instanceFilters("string")
    .description("string")
    .inventorySourceId("string")
    .enabledValue("string")
    .name("string")
    .groupBy("string")
    .source("string")
    .sourcePath("string")
    .sourceProjectId(0)
    .sourceRegions("string")
    .sourceVars("string")
    .updateCacheTimeout(0)
    .updateOnLaunch(false)
    .verbosity(0)
    .build());
Copy
inventory_source_resource = awx.InventorySource("inventorySourceResource",
    inventory_id=0,
    overwrite=False,
    overwrite_vars=False,
    enabled_var="string",
    credential_id=0,
    host_filter="string",
    instance_filters="string",
    description="string",
    inventory_source_id="string",
    enabled_value="string",
    name="string",
    group_by="string",
    source="string",
    source_path="string",
    source_project_id=0,
    source_regions="string",
    source_vars="string",
    update_cache_timeout=0,
    update_on_launch=False,
    verbosity=0)
Copy
const inventorySourceResource = new awx.InventorySource("inventorySourceResource", {
    inventoryId: 0,
    overwrite: false,
    overwriteVars: false,
    enabledVar: "string",
    credentialId: 0,
    hostFilter: "string",
    instanceFilters: "string",
    description: "string",
    inventorySourceId: "string",
    enabledValue: "string",
    name: "string",
    groupBy: "string",
    source: "string",
    sourcePath: "string",
    sourceProjectId: 0,
    sourceRegions: "string",
    sourceVars: "string",
    updateCacheTimeout: 0,
    updateOnLaunch: false,
    verbosity: 0,
});
Copy
type: awx:InventorySource
properties:
    credentialId: 0
    description: string
    enabledValue: string
    enabledVar: string
    groupBy: string
    hostFilter: string
    instanceFilters: string
    inventoryId: 0
    inventorySourceId: string
    name: string
    overwrite: false
    overwriteVars: false
    source: string
    sourcePath: string
    sourceProjectId: 0
    sourceRegions: string
    sourceVars: string
    updateCacheTimeout: 0
    updateOnLaunch: false
    verbosity: 0
Copy

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

InventoryId This property is required. double
CredentialId double
Description string
EnabledValue string
EnabledVar string
GroupBy string
HostFilter string
InstanceFilters string
InventorySourceId string
Name string
Overwrite bool
OverwriteVars bool
Source string
SourcePath string
SourceProjectId double
SourceRegions string
SourceVars string
UpdateCacheTimeout double
UpdateOnLaunch bool
Verbosity double
InventoryId This property is required. float64
CredentialId float64
Description string
EnabledValue string
EnabledVar string
GroupBy string
HostFilter string
InstanceFilters string
InventorySourceId string
Name string
Overwrite bool
OverwriteVars bool
Source string
SourcePath string
SourceProjectId float64
SourceRegions string
SourceVars string
UpdateCacheTimeout float64
UpdateOnLaunch bool
Verbosity float64
inventoryId This property is required. Double
credentialId Double
description String
enabledValue String
enabledVar String
groupBy String
hostFilter String
instanceFilters String
inventorySourceId String
name String
overwrite Boolean
overwriteVars Boolean
source String
sourcePath String
sourceProjectId Double
sourceRegions String
sourceVars String
updateCacheTimeout Double
updateOnLaunch Boolean
verbosity Double
inventoryId This property is required. number
credentialId number
description string
enabledValue string
enabledVar string
groupBy string
hostFilter string
instanceFilters string
inventorySourceId string
name string
overwrite boolean
overwriteVars boolean
source string
sourcePath string
sourceProjectId number
sourceRegions string
sourceVars string
updateCacheTimeout number
updateOnLaunch boolean
verbosity number
inventoryId This property is required. Number
credentialId Number
description String
enabledValue String
enabledVar String
groupBy String
hostFilter String
instanceFilters String
inventorySourceId String
name String
overwrite Boolean
overwriteVars Boolean
source String
sourcePath String
sourceProjectId Number
sourceRegions String
sourceVars String
updateCacheTimeout Number
updateOnLaunch Boolean
verbosity Number

Outputs

All input properties are implicitly available as output properties. Additionally, the InventorySource 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 InventorySource Resource

Get an existing InventorySource 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?: InventorySourceState, opts?: CustomResourceOptions): InventorySource
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_id: Optional[float] = None,
        description: Optional[str] = None,
        enabled_value: Optional[str] = None,
        enabled_var: Optional[str] = None,
        group_by: Optional[str] = None,
        host_filter: Optional[str] = None,
        instance_filters: Optional[str] = None,
        inventory_id: Optional[float] = None,
        inventory_source_id: Optional[str] = None,
        name: Optional[str] = None,
        overwrite: Optional[bool] = None,
        overwrite_vars: Optional[bool] = None,
        source: Optional[str] = None,
        source_path: Optional[str] = None,
        source_project_id: Optional[float] = None,
        source_regions: Optional[str] = None,
        source_vars: Optional[str] = None,
        update_cache_timeout: Optional[float] = None,
        update_on_launch: Optional[bool] = None,
        verbosity: Optional[float] = None) -> InventorySource
func GetInventorySource(ctx *Context, name string, id IDInput, state *InventorySourceState, opts ...ResourceOption) (*InventorySource, error)
public static InventorySource Get(string name, Input<string> id, InventorySourceState? state, CustomResourceOptions? opts = null)
public static InventorySource get(String name, Output<String> id, InventorySourceState state, CustomResourceOptions options)
resources:  _:    type: awx:InventorySource    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.
The following state arguments are supported:

Package Details

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