Package software.amazon.awscdk.services.cloudformation

Class CfnHookVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudformation.CfnHookVersion
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.509Z") @Stability(Stable) public class CfnHookVersion extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFormation::HookVersion.

The HookVersion resource publishes new or first hook version to the AWS CloudFormation registry.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnHookVersion cfnHookVersion = CfnHookVersion.Builder.create(this, "MyCfnHookVersion")
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnHookVersion

      protected CfnHookVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnHookVersion

      protected CfnHookVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnHookVersion

      @Stability(Stable) public CfnHookVersion(@NotNull Construct scope, @NotNull String id, @NotNull CfnHookVersionProps props)
      Create a new AWS::CloudFormation::HookVersion.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the hook.

    • getAttrIsDefaultVersion

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefaultVersion()
      Whether the specified hook version is set as the default version.

    • getAttrTypeArn

      @Stability(Stable) @NotNull public String getAttrTypeArn()
      The Amazon Resource Number (ARN) assigned to this version of the hook.

    • getAttrVersionId

      @Stability(Stable) @NotNull public String getAttrVersionId()
      The ID of this version of the hook.

    • getAttrVisibility

      @Stability(Stable) @NotNull public String getAttrVisibility()
      The scope at which the resource is visible and usable in CloudFormation operations.

      Valid values include:

      • PRIVATE : The resource is only visible and usable within the account in which it's registered. CloudFormation marks any resources you register as PRIVATE .
      • PUBLIC : The resource is publicly visible and usable within any Amazon account.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSchemaHandlerPackage

      @Stability(Stable) @NotNull public String getSchemaHandlerPackage()
      A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register.

      For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

      The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

    • setSchemaHandlerPackage

      @Stability(Stable) public void setSchemaHandlerPackage(@NotNull String value)
      A URL to the Amazon S3 bucket containing the hook project package that contains the necessary files for the hook you want to register.

      For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development .

      The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

    • getTypeName

      @Stability(Stable) @NotNull public String getTypeName()
      The unique name for your hook.

      Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook .

      The following organization namespaces are reserved and can't be used in your hook type names:

      • Alexa
      • AMZN
      • Amazon
      • ASK
      • AWS
      • Custom
      • Dev

    • setTypeName

      @Stability(Stable) public void setTypeName(@NotNull String value)
      The unique name for your hook.

      Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook .

      The following organization namespaces are reserved and can't be used in your hook type names:

      • Alexa
      • AMZN
      • Amazon
      • ASK
      • AWS
      • Custom
      • Dev

    • getExecutionRoleArn

      @Stability(Stable) @Nullable public String getExecutionRoleArn()
      The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.

    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the task execution role that grants the hook permission.

    • getLoggingConfig

      @Stability(Stable) @Nullable public Object getLoggingConfig()
      Contains logging configuration information for an extension.

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable CfnHookVersion.LoggingConfigProperty value)
      Contains logging configuration information for an extension.

    • setLoggingConfig

      @Stability(Stable) public void setLoggingConfig(@Nullable IResolvable value)
      Contains logging configuration information for an extension.