Package com.pulumi.aws.cloudformation

Class CloudFormationType

  • public class CloudFormationType
extends com.pulumi.resources.CustomResource
    Manages a version of a CloudFormation Type. ## Import Using `pulumi import`, import `aws.cloudformation.CloudFormationType` using the type version ARN. For example: ```sh $ pulumi import aws:cloudformation/cloudFormationType:CloudFormationType example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> defaultVersionId()  
      com.pulumi.core.Output<java.lang.String> deprecatedStatus()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.lang.String> documentationUrl()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> executionRoleArn()  
      static CloudFormationType get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CloudFormationTypeState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Boolean> isDefaultVersion()  
      com.pulumi.core.Output<java.util.Optional<CloudFormationTypeLoggingConfig>> loggingConfig()  
      com.pulumi.core.Output<java.lang.String> provisioningType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> schema()  
      com.pulumi.core.Output<java.lang.String> schemaHandlerPackage()  
      com.pulumi.core.Output<java.lang.String> sourceUrl()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.lang.String> typeArn()  
      com.pulumi.core.Output<java.lang.String> typeName()  
      com.pulumi.core.Output<java.lang.String> versionId()  
      com.pulumi.core.Output<java.lang.String> visibility()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CloudFormationType

        public CloudFormationType​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • CloudFormationType

        public CloudFormationType​(java.lang.String name,
                          CloudFormationTypeArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • CloudFormationType

        public CloudFormationType​(java.lang.String name,
                          CloudFormationTypeArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        (Optional) ARN of the CloudFormation Type version. See also `typeArn`.

      • defaultVersionId

        public com.pulumi.core.Output<java.lang.String> defaultVersionId()
        Returns:
        Identifier of the CloudFormation Type default version.

      • deprecatedStatus

        public com.pulumi.core.Output<java.lang.String> deprecatedStatus()
        Returns:
        Deprecation status of the version.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description of the version.

      • documentationUrl

        public com.pulumi.core.Output<java.lang.String> documentationUrl()
        Returns:
        URL of the documentation for the CloudFormation Type.

      • executionRoleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> executionRoleArn()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Boolean> isDefaultVersion()
        Returns:
        Whether the CloudFormation Type version is the default version.

      • loggingConfig

        public com.pulumi.core.Output<java.util.Optional<CloudFormationTypeLoggingConfig>> loggingConfig()
        Returns:
        Configuration block containing logging configuration.

      • provisioningType

        public com.pulumi.core.Output<java.lang.String> provisioningType()
        Returns:
        Provisioning behavior of the CloudFormation Type.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • schema

        public com.pulumi.core.Output<java.lang.String> schema()
        Returns:
        JSON document of the CloudFormation Type schema.

      • schemaHandlerPackage

        public com.pulumi.core.Output<java.lang.String> schemaHandlerPackage()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> sourceUrl()
        Returns:
        URL of the source code for the CloudFormation Type.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        CloudFormation Registry Type. For example, `RESOURCE` or `MODULE`.

      • typeArn

        public com.pulumi.core.Output<java.lang.String> typeArn()
        Returns:
        (Optional) ARN of the CloudFormation Type. See also `arn`.

      • typeName

        public com.pulumi.core.Output<java.lang.String> typeName()
        Returns:
        CloudFormation Type name. For example, `ExampleCompany::ExampleService::ExampleResource`.

      • versionId

        public com.pulumi.core.Output<java.lang.String> versionId()
        Returns:
        (Optional) Identifier of the CloudFormation Type version.

      • visibility

        public com.pulumi.core.Output<java.lang.String> visibility()
        Returns:
        Scope of the CloudFormation Type.

      • get

        public static CloudFormationType get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     CloudFormationTypeState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.