This resource allows you to upload a custom certificate to all servers in your cluster. Update is
not supported, all changes require replacement. ca, cert and private_key all use WriteOnly,
meaning no information is present in plan phase, logs or stored in the state for security purposes.
WARNING: Please note that when uploading a custom certificate or restoring to default certificate, all current connections will be closed.
Note: Destroying this resource will restore the cluster to use the default CloudAMQP certificate.
Only available for dedicated subscription plans running RabbitMQ.
Create CustomCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomCertificate(name: string, args: CustomCertificateArgs, opts?: CustomResourceOptions);@overload
def CustomCertificate(resource_name: str,
args: CustomCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
ca: Optional[str] = None,
cert: Optional[str] = None,
instance_id: Optional[int] = None,
private_key: Optional[str] = None,
sni_hosts: Optional[str] = None,
key_id: Optional[str] = None,
version: Optional[int] = None)func NewCustomCertificate(ctx *Context, name string, args CustomCertificateArgs, opts ...ResourceOption) (*CustomCertificate, error)public CustomCertificate(string name, CustomCertificateArgs args, CustomResourceOptions? opts = null)
public CustomCertificate(String name, CustomCertificateArgs args)
public CustomCertificate(String name, CustomCertificateArgs args, CustomResourceOptions options)
type: cloudamqp:CustomCertificate
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 CustomCertificateArgs
- 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 CustomCertificateArgs
- 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 CustomCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomCertificateArgs
- 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 customCertificateResource = new CloudAmqp.CustomCertificate("customCertificateResource", new()
{
Ca = "string",
Cert = "string",
InstanceId = 0,
PrivateKey = "string",
SniHosts = "string",
KeyId = "string",
Version = 0,
});
example, err := cloudamqp.NewCustomCertificate(ctx, "customCertificateResource", &cloudamqp.CustomCertificateArgs{
Ca: pulumi.String("string"),
Cert: pulumi.String("string"),
InstanceId: pulumi.Int(0),
PrivateKey: pulumi.String("string"),
SniHosts: pulumi.String("string"),
KeyId: pulumi.String("string"),
Version: pulumi.Int(0),
})
var customCertificateResource = new CustomCertificate("customCertificateResource", CustomCertificateArgs.builder()
.ca("string")
.cert("string")
.instanceId(0)
.privateKey("string")
.sniHosts("string")
.keyId("string")
.version(0)
.build());
custom_certificate_resource = cloudamqp.CustomCertificate("customCertificateResource",
ca="string",
cert="string",
instance_id=0,
private_key="string",
sni_hosts="string",
key_id="string",
version=0)
const customCertificateResource = new cloudamqp.CustomCertificate("customCertificateResource", {
ca: "string",
cert: "string",
instanceId: 0,
privateKey: "string",
sniHosts: "string",
keyId: "string",
version: 0,
});
type: cloudamqp:CustomCertificate
properties:
ca: string
cert: string
instanceId: 0
keyId: string
privateKey: string
sniHosts: string
version: 0
CustomCertificate 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 CustomCertificate resource accepts the following input properties:
- Ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- Cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- Instance
Id int - The CloudAMQP instance identifier.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- Sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- Key
Id string - A string based argument to trigger force new (default: "").
- Version int
- An integer based argument to trigger force new (default: 1).
- Ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- Cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- Instance
Id int - The CloudAMQP instance identifier.
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- Sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- Key
Id string - A string based argument to trigger force new (default: "").
- Version int
- An integer based argument to trigger force new (default: 1).
- ca String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id Integer - The CloudAMQP instance identifier.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts String - A hostname (Server Name Indication) that this certificate applies to.
- key
Id String - A string based argument to trigger force new (default: "").
- version Integer
- An integer based argument to trigger force new (default: 1).
- ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id number - The CloudAMQP instance identifier.
- private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- key
Id string - A string based argument to trigger force new (default: "").
- version number
- An integer based argument to trigger force new (default: 1).
- ca str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance_
id int - The CloudAMQP instance identifier.
- private_
key str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni_
hosts str - A hostname (Server Name Indication) that this certificate applies to.
- key_
id str - A string based argument to trigger force new (default: "").
- version int
- An integer based argument to trigger force new (default: 1).
- ca String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id Number - The CloudAMQP instance identifier.
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts String - A hostname (Server Name Indication) that this certificate applies to.
- key
Id String - A string based argument to trigger force new (default: "").
- version Number
- An integer based argument to trigger force new (default: 1).
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomCertificate 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 CustomCertificate Resource
Get an existing CustomCertificate 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?: CustomCertificateState, opts?: CustomResourceOptions): CustomCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
ca: Optional[str] = None,
cert: Optional[str] = None,
instance_id: Optional[int] = None,
key_id: Optional[str] = None,
private_key: Optional[str] = None,
sni_hosts: Optional[str] = None,
version: Optional[int] = None) -> CustomCertificatefunc GetCustomCertificate(ctx *Context, name string, id IDInput, state *CustomCertificateState, opts ...ResourceOption) (*CustomCertificate, error)public static CustomCertificate Get(string name, Input<string> id, CustomCertificateState? state, CustomResourceOptions? opts = null)public static CustomCertificate get(String name, Output<String> id, CustomCertificateState state, CustomResourceOptions options)resources: _: type: cloudamqp:CustomCertificate 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.
- Ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- Cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- Instance
Id int - The CloudAMQP instance identifier.
- Key
Id string - A string based argument to trigger force new (default: "").
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- Sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- Version int
- An integer based argument to trigger force new (default: 1).
- Ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- Cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- Instance
Id int - The CloudAMQP instance identifier.
- Key
Id string - A string based argument to trigger force new (default: "").
- Private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- Sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- Version int
- An integer based argument to trigger force new (default: 1).
- ca String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id Integer - The CloudAMQP instance identifier.
- key
Id String - A string based argument to trigger force new (default: "").
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts String - A hostname (Server Name Indication) that this certificate applies to.
- version Integer
- An integer based argument to trigger force new (default: 1).
- ca string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert string
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id number - The CloudAMQP instance identifier.
- key
Id string - A string based argument to trigger force new (default: "").
- private
Key string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts string - A hostname (Server Name Indication) that this certificate applies to.
- version number
- An integer based argument to trigger force new (default: 1).
- ca str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert str
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance_
id int - The CloudAMQP instance identifier.
- key_
id str - A string based argument to trigger force new (default: "").
- private_
key str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni_
hosts str - A hostname (Server Name Indication) that this certificate applies to.
- version int
- An integer based argument to trigger force new (default: 1).
- ca String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded Certificate Authority (CA).
- cert String
- NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded server certificate.
- instance
Id Number - The CloudAMQP instance identifier.
- key
Id String - A string based argument to trigger force new (default: "").
- private
Key String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The PEM-encoded private key corresponding to the certificate.
- sni
Hosts String - A hostname (Server Name Indication) that this certificate applies to.
- version Number
- An integer based argument to trigger force new (default: 1).
Package Details
- Repository
- CloudAMQP pulumi/pulumi-cloudamqp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudamqpTerraform Provider.
