CfnPublisher (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.cloudformation.CfnPublisher

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.003Z")
 @Stability(value=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();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnPublisher.Builder
A fluent builder for CfnPublisher.
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.constructs.IConstruct
  software.constructs.IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnPublisher.Builder` A fluent builder for `CfnPublisher`.

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnPublisher(software.constructs.Construct scope, String id, CfnPublisherProps props)` Create a new `AWS::CloudFormation::Publisher`.
`protected`	`CfnPublisher(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnPublisher(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`getAcceptTermsAndConditions()` Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry.
`String`	`getAttrIdentityProvider()` The type of account used as the identity provider when registering this publisher with CloudFormation .
`String`	`getAttrPublisherId()` The ID of the extension publisher.
`String`	`getAttrPublisherProfile()` The URL to the publisher's profile with the identity provider.
`String`	`getAttrPublisherStatus()` Whether the publisher is verified.
`protected Map<String,Object>`	`getCfnProperties()`
`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.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAcceptTermsAndConditions(Boolean value)` Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry.
`void`	`setAcceptTermsAndConditions(IResolvable value)` Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry.
`void`	`setConnectionArn(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.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnPublisher
```
protected CfnPublisher(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnPublisher
```
protected CfnPublisher(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnPublisher
```
@Stability(value=Stable)
public CfnPublisher(@NotNull
                                             software.constructs.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 Detail
  - inspect
```
@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrPublisherId()
```
    The ID of the extension publisher.
    This publisher ID applies to your account in all AWS Regions .
  - getAttrPublisherProfile
```
@Stability(value=Stable)
 @NotNull
public String getAttrPublisherProfile()
```
    The URL to the publisher's profile with the identity provider.
  - getAttrPublisherStatus
```
@Stability(value=Stable)
 @NotNull
public String getAttrPublisherStatus()
```
    Whether the publisher is verified.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getAcceptTermsAndConditions
```
@Stability(value=Stable)
 @NotNull
public Object getAcceptTermsAndConditions()
```
    Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) 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(value=Stable)
public void setAcceptTermsAndConditions(@NotNull
                                                                 Boolean value)
```
    Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) 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(value=Stable)
public void setAcceptTermsAndConditions(@NotNull
                                                                 IResolvable value)
```
    Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) 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(value=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(value=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 .

Class CfnPublisher

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnPublisher

CfnPublisher

CfnPublisher

Method Detail

inspect

renderProperties

getAttrIdentityProvider

getAttrPublisherId

getAttrPublisherProfile

getAttrPublisherStatus

getCfnProperties

getAcceptTermsAndConditions

setAcceptTermsAndConditions

setAcceptTermsAndConditions

getConnectionArn

setConnectionArn