CloudFormationType class
Manages a version of a CloudFormation Type.
Import
Using pulumi import, import aws.cloudformation.CloudFormationType using the type version ARN. For example:
$ pulumi import aws:cloudformation/cloudFormationType:CloudFormationType example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1
Constructors
- CloudFormationType(String name, {CloudFormationTypeArgs? args, CustomResourceOptions? options})
-
Creates a new CloudFormationType.
nameThe Pulumi resource name.argsArguments used to configure this CloudFormationType. The set of arguments for CloudFormationType.optionsResource options controlling this resource's behavior. - CloudFormationType.reference(String urn)
- Creates a typed reference to an existing CloudFormationType resource.
Properties
-
arn
↔ Output<
String> -
(Optional) ARN of the CloudFormation Type version. See also
typeArn.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
defaultVersionId
↔ Output<
String> -
Identifier of the CloudFormation Type default version.
latefinal
-
deprecatedStatus
↔ Output<
String> -
Deprecation status of the version.
latefinal
-
description
↔ Output<
String> -
Description of the version.
latefinal
-
documentationUrl
↔ Output<
String> -
URL of the documentation for the CloudFormation Type.
latefinal
-
executionRoleArn
↔ Output<
String?> -
ARN of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
latefinal
- 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
-
isDefaultVersion
↔ Output<
bool> -
Whether the CloudFormation Type version is the default version.
latefinal
- 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
-
loggingConfig
↔ Output<
CloudFormationTypeLoggingConfig?> -
Configuration block containing logging configuration.
latefinal
-
provisioningType
↔ Output<
String> -
Provisioning behavior of the CloudFormation Type.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
↔ Output<
String> -
JSON document of the CloudFormation Type schema.
latefinal
-
schemaHandlerPackage
↔ Output<
String> -
URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with
s3://orhttps://. For example,s3://example-bucket/example-object.latefinal -
sourceUrl
↔ Output<
String> -
URL of the source code for the CloudFormation Type.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
CloudFormation Registry Type. For example,
RESOURCEorMODULE.latefinal -
typeArn
↔ Output<
String> -
(Optional) ARN of the CloudFormation Type. See also
arn.latefinal -
typeName
↔ Output<
String> -
CloudFormation Type name. For example,
ExampleCompany::ExampleService::ExampleResource.latefinal -
urn
↔ Output<
String> -
latefinalinherited
-
versionId
↔ Output<
String> -
(Optional) Identifier of the CloudFormation Type version.
latefinal
-
visibility
↔ Output<
String> -
Scope of the CloudFormation Type.
latefinal
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, {CloudFormationTypeState? state, CustomResourceOptions? options}) → CloudFormationType -
Gets an existing CloudFormationType resource's state with the given
nameandid.