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

awx.CredentialScm

Explore with Pulumi AI

awx logo
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

    TBD

    Create CredentialScm Resource

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

    Constructor syntax

    new CredentialScm(name: string, args: CredentialScmArgs, opts?: CustomResourceOptions);
    @overload
    def CredentialScm(resource_name: str,
                      args: CredentialScmArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def CredentialScm(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      organization_id: Optional[float] = None,
                      credential_scm_id: Optional[str] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      password: Optional[str] = None,
                      ssh_key_data: Optional[str] = None,
                      ssh_key_unlock: Optional[str] = None,
                      username: Optional[str] = None)
    func NewCredentialScm(ctx *Context, name string, args CredentialScmArgs, opts ...ResourceOption) (*CredentialScm, error)
    public CredentialScm(string name, CredentialScmArgs args, CustomResourceOptions? opts = null)
    public CredentialScm(String name, CredentialScmArgs args)
    public CredentialScm(String name, CredentialScmArgs args, CustomResourceOptions options)
    
    type: awx:CredentialScm
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CredentialScmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CredentialScmArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CredentialScmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CredentialScmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CredentialScmArgs
    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 credentialScmResource = new Awx.CredentialScm("credentialScmResource", new()
    {
        OrganizationId = 0,
        CredentialScmId = "string",
        Description = "string",
        Name = "string",
        Password = "string",
        SshKeyData = "string",
        SshKeyUnlock = "string",
        Username = "string",
    });
    
    example, err := awx.NewCredentialScm(ctx, "credentialScmResource", &awx.CredentialScmArgs{
    	OrganizationId:  pulumi.Float64(0),
    	CredentialScmId: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Password:        pulumi.String("string"),
    	SshKeyData:      pulumi.String("string"),
    	SshKeyUnlock:    pulumi.String("string"),
    	Username:        pulumi.String("string"),
    })
    
    var credentialScmResource = new CredentialScm("credentialScmResource", CredentialScmArgs.builder()
        .organizationId(0)
        .credentialScmId("string")
        .description("string")
        .name("string")
        .password("string")
        .sshKeyData("string")
        .sshKeyUnlock("string")
        .username("string")
        .build());
    
    credential_scm_resource = awx.CredentialScm("credentialScmResource",
        organization_id=0,
        credential_scm_id="string",
        description="string",
        name="string",
        password="string",
        ssh_key_data="string",
        ssh_key_unlock="string",
        username="string")
    
    const credentialScmResource = new awx.CredentialScm("credentialScmResource", {
        organizationId: 0,
        credentialScmId: "string",
        description: "string",
        name: "string",
        password: "string",
        sshKeyData: "string",
        sshKeyUnlock: "string",
        username: "string",
    });
    
    type: awx:CredentialScm
    properties:
        credentialScmId: string
        description: string
        name: string
        organizationId: 0
        password: string
        sshKeyData: string
        sshKeyUnlock: string
        username: string
    

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

    OrganizationId double
    CredentialScmId string
    Description string
    Name string
    Password string
    SshKeyData string
    SshKeyUnlock string
    Username string
    OrganizationId float64
    CredentialScmId string
    Description string
    Name string
    Password string
    SshKeyData string
    SshKeyUnlock string
    Username string
    organizationId Double
    credentialScmId String
    description String
    name String
    password String
    sshKeyData String
    sshKeyUnlock String
    username String
    organizationId number
    credentialScmId string
    description string
    name string
    password string
    sshKeyData string
    sshKeyUnlock string
    username string
    organizationId Number
    credentialScmId String
    description String
    name String
    password String
    sshKeyData String
    sshKeyUnlock String
    username String

    Outputs

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

    Get an existing CredentialScm 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?: CredentialScmState, opts?: CustomResourceOptions): CredentialScm
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credential_scm_id: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[float] = None,
            password: Optional[str] = None,
            ssh_key_data: Optional[str] = None,
            ssh_key_unlock: Optional[str] = None,
            username: Optional[str] = None) -> CredentialScm
    func GetCredentialScm(ctx *Context, name string, id IDInput, state *CredentialScmState, opts ...ResourceOption) (*CredentialScm, error)
    public static CredentialScm Get(string name, Input<string> id, CredentialScmState? state, CustomResourceOptions? opts = null)
    public static CredentialScm get(String name, Output<String> id, CredentialScmState state, CustomResourceOptions options)
    resources:  _:    type: awx:CredentialScm    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    CredentialScmId string
    Description string
    Name string
    OrganizationId double
    Password string
    SshKeyData string
    SshKeyUnlock string
    Username string
    CredentialScmId string
    Description string
    Name string
    OrganizationId float64
    Password string
    SshKeyData string
    SshKeyUnlock string
    Username string
    credentialScmId String
    description String
    name String
    organizationId Double
    password String
    sshKeyData String
    sshKeyUnlock String
    username String
    credentialScmId string
    description string
    name string
    organizationId number
    password string
    sshKeyData string
    sshKeyUnlock string
    username string
    credentialScmId String
    description String
    name String
    organizationId Number
    password String
    sshKeyData String
    sshKeyUnlock String
    username String

    Package Details

    Repository
    awx denouche/terraform-provider-awx
    License
    Notes
    This Pulumi package is based on the awx Terraform Provider.
    awx logo
    awx 0.29.1 published on Monday, Apr 14, 2025 by denouche