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

awx.Setting

Explore with Pulumi AI

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

    Create Setting Resource

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

    Constructor syntax

    new Setting(name: string, args: SettingArgs, opts?: CustomResourceOptions);
    @overload
    def Setting(resource_name: str,
                args: SettingArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Setting(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                value: Optional[str] = None,
                name: Optional[str] = None,
                setting_id: Optional[str] = None,
                timeouts: Optional[SettingTimeoutsArgs] = None)
    func NewSetting(ctx *Context, name string, args SettingArgs, opts ...ResourceOption) (*Setting, error)
    public Setting(string name, SettingArgs args, CustomResourceOptions? opts = null)
    public Setting(String name, SettingArgs args)
    public Setting(String name, SettingArgs args, CustomResourceOptions options)
    
    type: awx:Setting
    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 SettingArgs
    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 SettingArgs
    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 SettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SettingArgs
    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 settingResource = new Awx.Setting("settingResource", new()
    {
        Value = "string",
        Name = "string",
        SettingId = "string",
        Timeouts = new Awx.Inputs.SettingTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := awx.NewSetting(ctx, "settingResource", &awx.SettingArgs{
    	Value:     pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	SettingId: pulumi.String("string"),
    	Timeouts: &awx.SettingTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var settingResource = new Setting("settingResource", SettingArgs.builder()
        .value("string")
        .name("string")
        .settingId("string")
        .timeouts(SettingTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    setting_resource = awx.Setting("settingResource",
        value="string",
        name="string",
        setting_id="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const settingResource = new awx.Setting("settingResource", {
        value: "string",
        name: "string",
        settingId: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: awx:Setting
    properties:
        name: string
        settingId: string
        timeouts:
            create: string
            delete: string
            update: string
        value: string
    

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

    Value string
    Value to be modified for given setting.
    Name string
    Name of setting to modify
    SettingId string
    Timeouts SettingTimeouts
    Value string
    Value to be modified for given setting.
    Name string
    Name of setting to modify
    SettingId string
    Timeouts SettingTimeoutsArgs
    value String
    Value to be modified for given setting.
    name String
    Name of setting to modify
    settingId String
    timeouts SettingTimeouts
    value string
    Value to be modified for given setting.
    name string
    Name of setting to modify
    settingId string
    timeouts SettingTimeouts
    value str
    Value to be modified for given setting.
    name str
    Name of setting to modify
    setting_id str
    timeouts SettingTimeoutsArgs
    value String
    Value to be modified for given setting.
    name String
    Name of setting to modify
    settingId String
    timeouts Property Map

    Outputs

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

    Get an existing Setting 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?: SettingState, opts?: CustomResourceOptions): Setting
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            setting_id: Optional[str] = None,
            timeouts: Optional[SettingTimeoutsArgs] = None,
            value: Optional[str] = None) -> Setting
    func GetSetting(ctx *Context, name string, id IDInput, state *SettingState, opts ...ResourceOption) (*Setting, error)
    public static Setting Get(string name, Input<string> id, SettingState? state, CustomResourceOptions? opts = null)
    public static Setting get(String name, Output<String> id, SettingState state, CustomResourceOptions options)
    resources:  _:    type: awx:Setting    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:
    Name string
    Name of setting to modify
    SettingId string
    Timeouts SettingTimeouts
    Value string
    Value to be modified for given setting.
    Name string
    Name of setting to modify
    SettingId string
    Timeouts SettingTimeoutsArgs
    Value string
    Value to be modified for given setting.
    name String
    Name of setting to modify
    settingId String
    timeouts SettingTimeouts
    value String
    Value to be modified for given setting.
    name string
    Name of setting to modify
    settingId string
    timeouts SettingTimeouts
    value string
    Value to be modified for given setting.
    name str
    Name of setting to modify
    setting_id str
    timeouts SettingTimeoutsArgs
    value str
    Value to be modified for given setting.
    name String
    Name of setting to modify
    settingId String
    timeouts Property Map
    value String
    Value to be modified for given setting.

    Supporting Types

    SettingTimeouts, SettingTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update 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