1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. TentacleCertificate
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploy.TentacleCertificate

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

    Generates a X.509 self-signed certificate for use with a Octopus Deploy Tentacle.

    Octopus certificates

    The X.509 certificates generated are self-signed, 2048-bit private keys and intended for use only between Octopus Server and Tentacle communications. There is an insightful discussion of why Octopus uses self-signed certificates by default.

    Instead of generating a new certificate through this resource you can use an existing certificate and simply reference the appropriate thumbprint when registering the target.

    State Persistence

    This resource that is generated will be stored in the state file and cannot be retrieved later from the external Octopus Server or Tentacle.

    Create TentacleCertificate Resource

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

    Constructor syntax

    new TentacleCertificate(name: string, args?: TentacleCertificateArgs, opts?: CustomResourceOptions);
    @overload
    def TentacleCertificate(resource_name: str,
                            args: Optional[TentacleCertificateArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def TentacleCertificate(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            dependencies: Optional[Mapping[str, str]] = None)
    func NewTentacleCertificate(ctx *Context, name string, args *TentacleCertificateArgs, opts ...ResourceOption) (*TentacleCertificate, error)
    public TentacleCertificate(string name, TentacleCertificateArgs? args = null, CustomResourceOptions? opts = null)
    public TentacleCertificate(String name, TentacleCertificateArgs args)
    public TentacleCertificate(String name, TentacleCertificateArgs args, CustomResourceOptions options)
    
    type: octopusdeploy:TentacleCertificate
    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 TentacleCertificateArgs
    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 TentacleCertificateArgs
    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 TentacleCertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TentacleCertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TentacleCertificateArgs
    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 tentacleCertificateResource = new Octopusdeploy.TentacleCertificate("tentacleCertificateResource", new()
    {
        Dependencies = 
        {
            { "string", "string" },
        },
    });
    
    example, err := octopusdeploy.NewTentacleCertificate(ctx, "tentacleCertificateResource", &octopusdeploy.TentacleCertificateArgs{
    	Dependencies: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var tentacleCertificateResource = new TentacleCertificate("tentacleCertificateResource", TentacleCertificateArgs.builder()
        .dependencies(Map.of("string", "string"))
        .build());
    
    tentacle_certificate_resource = octopusdeploy.TentacleCertificate("tentacleCertificateResource", dependencies={
        "string": "string",
    })
    
    const tentacleCertificateResource = new octopusdeploy.TentacleCertificate("tentacleCertificateResource", {dependencies: {
        string: "string",
    }});
    
    type: octopusdeploy:TentacleCertificate
    properties:
        dependencies:
            string: string
    

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

    Dependencies Dictionary<string, string>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    Dependencies map[string]string
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    dependencies Map<String,String>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    dependencies {[key: string]: string}
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    dependencies Mapping[str, str]
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    dependencies Map<String>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TentacleCertificate resource produces the following output properties:

    Base64 string
    The base64 encoded pfx certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    Thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    Base64 string
    The base64 encoded pfx certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    Thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 String
    The base64 encoded pfx certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    thumbprint String
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 string
    The base64 encoded pfx certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 str
    The base64 encoded pfx certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    thumbprint str
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 String
    The base64 encoded pfx certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    thumbprint String
    The SHA1 sum of the certificate represented in hexadecimal.

    Look up Existing TentacleCertificate Resource

    Get an existing TentacleCertificate 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?: TentacleCertificateState, opts?: CustomResourceOptions): TentacleCertificate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            base64: Optional[str] = None,
            dependencies: Optional[Mapping[str, str]] = None,
            thumbprint: Optional[str] = None) -> TentacleCertificate
    func GetTentacleCertificate(ctx *Context, name string, id IDInput, state *TentacleCertificateState, opts ...ResourceOption) (*TentacleCertificate, error)
    public static TentacleCertificate Get(string name, Input<string> id, TentacleCertificateState? state, CustomResourceOptions? opts = null)
    public static TentacleCertificate get(String name, Output<String> id, TentacleCertificateState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:TentacleCertificate    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:
    Base64 string
    The base64 encoded pfx certificate.
    Dependencies Dictionary<string, string>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    Thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    Base64 string
    The base64 encoded pfx certificate.
    Dependencies map[string]string
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    Thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 String
    The base64 encoded pfx certificate.
    dependencies Map<String,String>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    thumbprint String
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 string
    The base64 encoded pfx certificate.
    dependencies {[key: string]: string}
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    thumbprint string
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 str
    The base64 encoded pfx certificate.
    dependencies Mapping[str, str]
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    thumbprint str
    The SHA1 sum of the certificate represented in hexadecimal.
    base64 String
    The base64 encoded pfx certificate.
    dependencies Map<String>
    Optional map of dependencies that when modified will trigger a re-creation of this resource.
    thumbprint String
    The SHA1 sum of the certificate represented in hexadecimal.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs