CloudFormationTypeState class

Input properties used for looking up and filtering CloudFormationType resources.

Constructors

CloudFormationTypeState({Input<String?>? arn, Input<String?>? defaultVersionId, Input<String?>? deprecatedStatus, Input<String?>? description, Input<String?>? documentationUrl, Input<String?>? executionRoleArn, Input<bool?>? isDefaultVersion, Input<CloudFormationTypeLoggingConfig?>? loggingConfig, Input<String?>? provisioningType, Input<String?>? region, Input<String?>? schema, Input<String?>? schemaHandlerPackage, Input<String?>? sourceUrl, Input<String?>? type, Input<String?>? typeArn, Input<String?>? typeName, Input<String?>? versionId, Input<String?>? visibility})
Creates a new CloudFormationTypeState. arn (Optional) ARN of the CloudFormation Type version. See also typeArn. defaultVersionId Identifier of the CloudFormation Type default version. deprecatedStatus Deprecation status of the version. description Description of the version. documentationUrl URL of the documentation for the CloudFormation Type. executionRoleArn 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. isDefaultVersion Whether the CloudFormation Type version is the default version. loggingConfig Configuration block containing logging configuration. provisioningType Provisioning behavior of the CloudFormation Type. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. schema JSON document of the CloudFormation Type schema. schemaHandlerPackage 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:// or https://. For example, s3://example-bucket/example-object. sourceUrl URL of the source code for the CloudFormation Type. type CloudFormation Registry Type. For example, RESOURCE or MODULE. typeArn (Optional) ARN of the CloudFormation Type. See also arn. typeName CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource. versionId (Optional) Identifier of the CloudFormation Type version. visibility Scope of the CloudFormation Type.
const
CloudFormationTypeState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
(Optional) ARN of the CloudFormation Type version. See also typeArn.
final
defaultVersionId → Input<String?>?
Identifier of the CloudFormation Type default version.
final
deprecatedStatus → Input<String?>?
Deprecation status of the version.
final
description → Input<String?>?
Description of the version.
final
documentationUrl → Input<String?>?
URL of the documentation for the CloudFormation Type.
final
executionRoleArn → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
isDefaultVersion → Input<bool?>?
Whether the CloudFormation Type version is the default version.
final
loggingConfig → Input<CloudFormationTypeLoggingConfig?>?
Configuration block containing logging configuration.
final
provisioningType → Input<String?>?
Provisioning behavior of the CloudFormation Type.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Input<String?>?
JSON document of the CloudFormation Type schema.
final
schemaHandlerPackage → Input<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:// or https://. For example, s3://example-bucket/example-object.
final
sourceUrl → Input<String?>?
URL of the source code for the CloudFormation Type.
final
type → Input<String?>?
CloudFormation Registry Type. For example, RESOURCE or MODULE.
final
typeArn → Input<String?>?
(Optional) ARN of the CloudFormation Type. See also arn.
final
typeName → Input<String?>?
CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.
final
versionId → Input<String?>?
(Optional) Identifier of the CloudFormation Type version.
final
visibility → Input<String?>?
Scope of the CloudFormation Type.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited