Docs
PackagesConsul v3.11.2 published on Thursday, Mar 21, 2024 by Pulumi
consul.CertificateAuthority
Explore with Pulumi AI
The consul.CertificateAuthority resource can be used to manage the configuration of the Certificate Authority used by Consul Connect.
Note: The keys in the
configargument must be using Camel case.
Create CertificateAuthority Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CertificateAuthority(name: string, args: CertificateAuthorityArgs, opts?: CustomResourceOptions);@overload
def CertificateAuthority(resource_name: str,
args: CertificateAuthorityArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CertificateAuthority(resource_name: str,
opts: Optional[ResourceOptions] = None,
connect_provider: Optional[str] = None,
config: Optional[Mapping[str, str]] = None,
config_json: Optional[str] = None)func NewCertificateAuthority(ctx *Context, name string, args CertificateAuthorityArgs, opts ...ResourceOption) (*CertificateAuthority, error)public CertificateAuthority(string name, CertificateAuthorityArgs args, CustomResourceOptions? opts = null)
public CertificateAuthority(String name, CertificateAuthorityArgs args)
public CertificateAuthority(String name, CertificateAuthorityArgs args, CustomResourceOptions options)
type: consul:CertificateAuthority
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 CertificateAuthorityArgs
- 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 CertificateAuthorityArgs
- 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 CertificateAuthorityArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CertificateAuthorityArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CertificateAuthorityArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var certificateAuthorityResource = new Consul.CertificateAuthority("certificateAuthorityResource", new()
{
ConnectProvider = "string",
ConfigJson = "string",
});
example, err := consul.NewCertificateAuthority(ctx, "certificateAuthorityResource", &consul.CertificateAuthorityArgs{
ConnectProvider: pulumi.String("string"),
ConfigJson: pulumi.String("string"),
})
var certificateAuthorityResource = new CertificateAuthority("certificateAuthorityResource", CertificateAuthorityArgs.builder()
.connectProvider("string")
.configJson("string")
.build());
certificate_authority_resource = consul.CertificateAuthority("certificateAuthorityResource",
connect_provider="string",
config_json="string")
const certificateAuthorityResource = new consul.CertificateAuthority("certificateAuthorityResource", {
connectProvider: "string",
configJson: "string",
});
type: consul:CertificateAuthority
properties:
configJson: string
connectProvider: string
CertificateAuthority Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CertificateAuthority resource accepts the following input properties:
- Connect
Provider string - Specifies the CA provider type to use.
- Config Dictionary<string, string>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Connect
Provider string - Specifies the CA provider type to use.
- Config map[string]string
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider String - Specifies the CA provider type to use.
- config Map<String,String>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json String - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider string - Specifies the CA provider type to use.
- config {[key: string]: string}
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect_
provider str - Specifies the CA provider type to use.
- config Mapping[str, str]
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config_
json str - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider String - Specifies the CA provider type to use.
- config Map<String>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json String - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
Outputs
All input properties are implicitly available as output properties. Additionally, the CertificateAuthority 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 CertificateAuthority Resource
Get an existing CertificateAuthority 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?: CertificateAuthorityState, opts?: CustomResourceOptions): CertificateAuthority@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[Mapping[str, str]] = None,
config_json: Optional[str] = None,
connect_provider: Optional[str] = None) -> CertificateAuthorityfunc GetCertificateAuthority(ctx *Context, name string, id IDInput, state *CertificateAuthorityState, opts ...ResourceOption) (*CertificateAuthority, error)public static CertificateAuthority Get(string name, Input<string> id, CertificateAuthorityState? state, CustomResourceOptions? opts = null)public static CertificateAuthority get(String name, Output<String> id, CertificateAuthorityState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Config Dictionary<string, string>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Connect
Provider string - Specifies the CA provider type to use.
- Config map[string]string
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- Connect
Provider string - Specifies the CA provider type to use.
- config Map<String,String>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json String - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider String - Specifies the CA provider type to use.
- config {[key: string]: string}
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json string - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider string - Specifies the CA provider type to use.
- config Mapping[str, str]
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config_
json str - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect_
provider str - Specifies the CA provider type to use.
- config Map<String>
- The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- config
Json String - The raw configuration to use for the chosen provider. For more information on configuring the Connect CA providers, see Provider Config.
- connect
Provider String - Specifies the CA provider type to use.
Import
$ pulumi import consul:index/certificateAuthority:CertificateAuthority connect connect-ca
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- HashiCorp Consul pulumi/pulumi-consul
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
consulTerraform Provider.