1. Packages
  2. Akeyless Provider
  3. API Docs
  4. TargetWindows
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.TargetWindows

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    windows Target resource

    Create TargetWindows Resource

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

    Constructor syntax

    new TargetWindows(name: string, args: TargetWindowsArgs, opts?: CustomResourceOptions);
    @overload
    def TargetWindows(resource_name: str,
                      args: TargetWindowsArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def TargetWindows(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      hostname: Optional[str] = None,
                      password: Optional[str] = None,
                      username: Optional[str] = None,
                      certificate: Optional[str] = None,
                      description: Optional[str] = None,
                      domain: Optional[str] = None,
                      key: Optional[str] = None,
                      name: Optional[str] = None,
                      port: Optional[str] = None,
                      target_windows_id: Optional[str] = None,
                      use_tls: Optional[str] = None)
    func NewTargetWindows(ctx *Context, name string, args TargetWindowsArgs, opts ...ResourceOption) (*TargetWindows, error)
    public TargetWindows(string name, TargetWindowsArgs args, CustomResourceOptions? opts = null)
    public TargetWindows(String name, TargetWindowsArgs args)
    public TargetWindows(String name, TargetWindowsArgs args, CustomResourceOptions options)
    
    type: akeyless:TargetWindows
    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 TargetWindowsArgs
    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 TargetWindowsArgs
    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 TargetWindowsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetWindowsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetWindowsArgs
    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 targetWindowsResource = new Akeyless.TargetWindows("targetWindowsResource", new()
    {
        Hostname = "string",
        Password = "string",
        Username = "string",
        Certificate = "string",
        Description = "string",
        Domain = "string",
        Key = "string",
        Name = "string",
        Port = "string",
        TargetWindowsId = "string",
        UseTls = "string",
    });
    
    example, err := akeyless.NewTargetWindows(ctx, "targetWindowsResource", &akeyless.TargetWindowsArgs{
    	Hostname:        pulumi.String("string"),
    	Password:        pulumi.String("string"),
    	Username:        pulumi.String("string"),
    	Certificate:     pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Domain:          pulumi.String("string"),
    	Key:             pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Port:            pulumi.String("string"),
    	TargetWindowsId: pulumi.String("string"),
    	UseTls:          pulumi.String("string"),
    })
    
    var targetWindowsResource = new TargetWindows("targetWindowsResource", TargetWindowsArgs.builder()
        .hostname("string")
        .password("string")
        .username("string")
        .certificate("string")
        .description("string")
        .domain("string")
        .key("string")
        .name("string")
        .port("string")
        .targetWindowsId("string")
        .useTls("string")
        .build());
    
    target_windows_resource = akeyless.TargetWindows("targetWindowsResource",
        hostname="string",
        password="string",
        username="string",
        certificate="string",
        description="string",
        domain="string",
        key="string",
        name="string",
        port="string",
        target_windows_id="string",
        use_tls="string")
    
    const targetWindowsResource = new akeyless.TargetWindows("targetWindowsResource", {
        hostname: "string",
        password: "string",
        username: "string",
        certificate: "string",
        description: "string",
        domain: "string",
        key: "string",
        name: "string",
        port: "string",
        targetWindowsId: "string",
        useTls: "string",
    });
    
    type: akeyless:TargetWindows
    properties:
        certificate: string
        description: string
        domain: string
        hostname: string
        key: string
        name: string
        password: string
        port: string
        targetWindowsId: string
        useTls: string
        username: string
    

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

    Hostname string
    server hostname or IP Address
    Password string
    Privileged user password
    Username string
    Privileged username
    Certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    Description string
    Description of the object
    Domain string
    User domain name
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    Server WinRM port
    TargetWindowsId string
    The ID of this resource.
    UseTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    Hostname string
    server hostname or IP Address
    Password string
    Privileged user password
    Username string
    Privileged username
    Certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    Description string
    Description of the object
    Domain string
    User domain name
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    Name string
    Target name
    Port string
    Server WinRM port
    TargetWindowsId string
    The ID of this resource.
    UseTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    hostname String
    server hostname or IP Address
    password String
    Privileged user password
    username String
    Privileged username
    certificate String
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description String
    Description of the object
    domain String
    User domain name
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    Server WinRM port
    targetWindowsId String
    The ID of this resource.
    useTls String
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    hostname string
    server hostname or IP Address
    password string
    Privileged user password
    username string
    Privileged username
    certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description string
    Description of the object
    domain string
    User domain name
    key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name string
    Target name
    port string
    Server WinRM port
    targetWindowsId string
    The ID of this resource.
    useTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    hostname str
    server hostname or IP Address
    password str
    Privileged user password
    username str
    Privileged username
    certificate str
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description str
    Description of the object
    domain str
    User domain name
    key str
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name str
    Target name
    port str
    Server WinRM port
    target_windows_id str
    The ID of this resource.
    use_tls str
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    hostname String
    server hostname or IP Address
    password String
    Privileged user password
    username String
    Privileged username
    certificate String
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description String
    Description of the object
    domain String
    User domain name
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name String
    Target name
    port String
    Server WinRM port
    targetWindowsId String
    The ID of this resource.
    useTls String
    Enable/Disable TLS for WinRM over HTTPS [true/false]

    Outputs

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

    Get an existing TargetWindows 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?: TargetWindowsState, opts?: CustomResourceOptions): TargetWindows
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate: Optional[str] = None,
            description: Optional[str] = None,
            domain: Optional[str] = None,
            hostname: Optional[str] = None,
            key: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            port: Optional[str] = None,
            target_windows_id: Optional[str] = None,
            use_tls: Optional[str] = None,
            username: Optional[str] = None) -> TargetWindows
    func GetTargetWindows(ctx *Context, name string, id IDInput, state *TargetWindowsState, opts ...ResourceOption) (*TargetWindows, error)
    public static TargetWindows Get(string name, Input<string> id, TargetWindowsState? state, CustomResourceOptions? opts = null)
    public static TargetWindows get(String name, Output<String> id, TargetWindowsState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:TargetWindows    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:
    Certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    Description string
    Description of the object
    Domain string
    User domain name
    Hostname string
    server hostname or IP Address
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    Name string
    Target name
    Password string
    Privileged user password
    Port string
    Server WinRM port
    TargetWindowsId string
    The ID of this resource.
    UseTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    Username string
    Privileged username
    Certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    Description string
    Description of the object
    Domain string
    User domain name
    Hostname string
    server hostname or IP Address
    Key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    Name string
    Target name
    Password string
    Privileged user password
    Port string
    Server WinRM port
    TargetWindowsId string
    The ID of this resource.
    UseTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    Username string
    Privileged username
    certificate String
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description String
    Description of the object
    domain String
    User domain name
    hostname String
    server hostname or IP Address
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name String
    Target name
    password String
    Privileged user password
    port String
    Server WinRM port
    targetWindowsId String
    The ID of this resource.
    useTls String
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    username String
    Privileged username
    certificate string
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description string
    Description of the object
    domain string
    User domain name
    hostname string
    server hostname or IP Address
    key string
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name string
    Target name
    password string
    Privileged user password
    port string
    Server WinRM port
    targetWindowsId string
    The ID of this resource.
    useTls string
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    username string
    Privileged username
    certificate str
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description str
    Description of the object
    domain str
    User domain name
    hostname str
    server hostname or IP Address
    key str
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name str
    Target name
    password str
    Privileged user password
    port str
    Server WinRM port
    target_windows_id str
    The ID of this resource.
    use_tls str
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    username str
    Privileged username
    certificate String
    SSL CA certificate in base64 encoding generated from a trusted Certificate Authority (CA)
    description String
    Description of the object
    domain String
    User domain name
    hostname String
    server hostname or IP Address
    key String
    Key name. The key is used to encrypt the target secret value. If the key name is not specified, the account default protection key is used
    name String
    Target name
    password String
    Privileged user password
    port String
    Server WinRM port
    targetWindowsId String
    The ID of this resource.
    useTls String
    Enable/Disable TLS for WinRM over HTTPS [true/false]
    username String
    Privileged username

    Package Details

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