Package software.amazon.awscdk.services.cloudformation

Class CfnPublisher

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.CfnPublisher
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.526Z") @Stability(Stable) public class CfnPublisher extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFormation::Publisher.

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.

For information on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide .

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.*;
 CfnPublisher cfnPublisher = CfnPublisher.Builder.create(this, "MyCfnPublisher")
         .acceptTermsAndConditions(false)
         // the properties below are optional
         .connectionArn("connectionArn")
         .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

    • CfnPublisher

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

    • CfnPublisher

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

    • CfnPublisher

      @Stability(Stable) public CfnPublisher(@NotNull Construct scope, @NotNull String id, @NotNull CfnPublisherProps props)
      Create a new AWS::CloudFormation::Publisher.

      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.

    • getAttrIdentityProvider

      @Stability(Stable) @NotNull public String getAttrIdentityProvider()
      The type of account used as the identity provider when registering this publisher with CloudFormation .

      Values include: AWS_Marketplace | Bitbucket | GitHub .

    • getAttrPublisherId

      @Stability(Stable) @NotNull public String getAttrPublisherId()
      The ID of the extension publisher.

      This publisher ID applies to your account in all AWS Regions .

    • getAttrPublisherProfile

      @Stability(Stable) @NotNull public String getAttrPublisherProfile()
      The URL to the publisher's profile with the identity provider.

    • getAttrPublisherStatus

      @Stability(Stable) @NotNull public String getAttrPublisherStatus()
      Whether the publisher is verified.

    • getCfnProperties

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

    • getAcceptTermsAndConditions

      @Stability(Stable) @NotNull public Object getAcceptTermsAndConditions()
      Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

      The default is false .

    • setAcceptTermsAndConditions

      @Stability(Stable) public void setAcceptTermsAndConditions(@NotNull Boolean value)
      Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

      The default is false .

    • setAcceptTermsAndConditions

      @Stability(Stable) public void setAcceptTermsAndConditions(@NotNull IResolvable value)
      Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

      The default is false .

    • getConnectionArn

      @Stability(Stable) @Nullable public String getConnectionArn()
      If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

      For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide .

    • setConnectionArn

      @Stability(Stable) public void setConnectionArn(@Nullable String value)
      If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

      For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide .