CaExternalAccountKey class
A representation of an ExternalAccountKey used for external account binding within ACME.
To get more information about ExternalAccountKey, see:
- API documentation
- How-to Guides
- Official Documentation
- Request Certificate Using Public CA
- Request EAB key ID and HMAC
> Warning: This resource is create-only and could not be read from the API. On delete, the resource would be removed from the state. You must use an EAB secret within 7 days of obtaining it. The EAB secret is invalidated if you don't use it within 7 days. The ACME account registered by using an EAB secret has no expiration.
Example Usage
Public Ca External Account Key
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const prod = new gcp.compute.CaExternalAccountKey("prod", {project: "my-project-name"});
import pulumi
import pulumi_gcp as gcp
prod = gcp.compute.CaExternalAccountKey("prod", project="my-project-name")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var prod = new Gcp.Compute.CaExternalAccountKey("prod", new()
{
Project = "my-project-name",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewCaExternalAccountKey(ctx, "prod", &compute.CaExternalAccountKeyArgs{
Project: pulumi.String("my-project-name"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_compute_caexternalaccountkey" "prod" {
project = "my-project-name"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.CaExternalAccountKey;
import com.pulumi.gcp.compute.CaExternalAccountKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var prod = new CaExternalAccountKey("prod", CaExternalAccountKeyArgs.builder()
.project("my-project-name")
.build());
}
}
resources:
prod:
type: gcp:compute:CaExternalAccountKey
properties:
project: my-project-name
Import
This resource does not support import.
Constructors
- CaExternalAccountKey(String name, {CaExternalAccountKeyArgs? args, CustomResourceOptions? options})
-
Creates a new CaExternalAccountKey.
nameThe Pulumi resource name.argsArguments used to configure this CaExternalAccountKey. The set of arguments for CaExternalAccountKey.optionsResource options controlling this resource's behavior. - CaExternalAccountKey.reference(String urn)
- Creates a typed reference to an existing CaExternalAccountKey resource.
Properties
-
b64MacKey
↔ Output<
String> -
(Deprecated)
Doubly Base64-URL-encoded HS256 key ('base64(base64(binary key))'). It is generated by the PublicCertificateAuthorityService
when the ExternalAccountKey is created.
Note: This property is sensitive and will not be displayed in the plan.
latefinal
-
b64urlMacKey
↔ Output<
String> -
(Deprecated)
Doubly Base64-URL-encoded HS256 key ('base64(base64(binary key))'). It is generated by the PublicCertificateAuthorityService
when the ExternalAccountKey is created.'
Note: This property is sensitive and will not be displayed in the plan.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
keyId
↔ Output<
String> -
It is generated by the PublicCertificateAuthorityService when the ExternalAccountKey is created.
Note: This property is sensitive and will not be displayed in the plan.
latefinal
-
location
↔ Output<
String?> -
Location for the externalAccountKey. Currently only
globalis supported.latefinal -
macKey
↔ Output<
String> -
Base64-URL-encoded HS256 key. It is generated by the PublicCertificateAuthorityService
when the ExternalAccountKey is created.'
Note: This property is sensitive and will not be displayed in the plan.
latefinal
-
name
↔ Output<
String> -
Resource name. projects/{project}/locations/{location}/externalAccountKeys/{keyId}.
latefinal
-
project
↔ Output<
String> -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {CaExternalAccountKeyState? state, CustomResourceOptions? options}) → CaExternalAccountKey -
Gets an existing CaExternalAccountKey resource's state with the given
nameandid.