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

awx.Credential

Explore with Pulumi AI

TBD

Create Credential Resource

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

Constructor syntax

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

@overload
def Credential(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               credential_type_id: Optional[float] = None,
               inputs: Optional[str] = None,
               organization_id: Optional[float] = None,
               credential_id: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
func NewCredential(ctx *Context, name string, args CredentialArgs, opts ...ResourceOption) (*Credential, error)
public Credential(string name, CredentialArgs args, CustomResourceOptions? opts = null)
public Credential(String name, CredentialArgs args)
public Credential(String name, CredentialArgs args, CustomResourceOptions options)
type: awx:Credential
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. CredentialArgs
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. CredentialArgs
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. CredentialArgs
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. CredentialArgs
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. CredentialArgs
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 credentialResource = new Awx.Credential("credentialResource", new()
{
    CredentialTypeId = 0,
    Inputs = "string",
    OrganizationId = 0,
    CredentialId = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := awx.NewCredential(ctx, "credentialResource", &awx.CredentialArgs{
	CredentialTypeId: pulumi.Float64(0),
	Inputs:           pulumi.String("string"),
	OrganizationId:   pulumi.Float64(0),
	CredentialId:     pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
})
Copy
var credentialResource = new Credential("credentialResource", CredentialArgs.builder()
    .credentialTypeId(0)
    .inputs("string")
    .organizationId(0)
    .credentialId("string")
    .description("string")
    .name("string")
    .build());
Copy
credential_resource = awx.Credential("credentialResource",
    credential_type_id=0,
    inputs="string",
    organization_id=0,
    credential_id="string",
    description="string",
    name="string")
Copy
const credentialResource = new awx.Credential("credentialResource", {
    credentialTypeId: 0,
    inputs: "string",
    organizationId: 0,
    credentialId: "string",
    description: "string",
    name: "string",
});
Copy
type: awx:Credential
properties:
    credentialId: string
    credentialTypeId: 0
    description: string
    inputs: string
    name: string
    organizationId: 0
Copy

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

CredentialTypeId This property is required. double
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
Inputs This property is required. string
OrganizationId This property is required. double
CredentialId string
Description string
Name string
CredentialTypeId This property is required. float64
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
Inputs This property is required. string
OrganizationId This property is required. float64
CredentialId string
Description string
Name string
credentialTypeId This property is required. Double
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
inputs This property is required. String
organizationId This property is required. Double
credentialId String
description String
name String
credentialTypeId This property is required. number
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
inputs This property is required. string
organizationId This property is required. number
credentialId string
description string
name string
credential_type_id This property is required. float
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
inputs This property is required. str
organization_id This property is required. float
credential_id str
description str
name str
credentialTypeId This property is required. Number
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
inputs This property is required. String
organizationId This property is required. Number
credentialId String
description String
name String

Outputs

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

Get an existing Credential 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?: CredentialState, opts?: CustomResourceOptions): Credential
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credential_id: Optional[str] = None,
        credential_type_id: Optional[float] = None,
        description: Optional[str] = None,
        inputs: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[float] = None) -> Credential
func GetCredential(ctx *Context, name string, id IDInput, state *CredentialState, opts ...ResourceOption) (*Credential, error)
public static Credential Get(string name, Input<string> id, CredentialState? state, CustomResourceOptions? opts = null)
public static Credential get(String name, Output<String> id, CredentialState state, CustomResourceOptions options)
resources:  _:    type: awx:Credential    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:
CredentialId string
CredentialTypeId double
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
Description string
Inputs string
Name string
OrganizationId double
CredentialId string
CredentialTypeId float64
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
Description string
Inputs string
Name string
OrganizationId float64
credentialId String
credentialTypeId Double
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
description String
inputs String
name String
organizationId Double
credentialId string
credentialTypeId number
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
description string
inputs string
name string
organizationId number
credential_id str
credential_type_id float
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
description str
inputs str
name str
organization_id float
credentialId String
credentialTypeId Number
Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type
description String
inputs String
name String
organizationId Number

Package Details

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