Package software.amazon.awscdk.services.datazone

Class CfnSubscriptionTarget

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.datazone.CfnSubscriptionTarget

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.686Z")
@Stability(Stable)
public class CfnSubscriptionTarget
extends CfnResource
implements IInspectable

The AWS::DataZone::SubscriptionTarget resource specifies an Amazon DataZone subscription target.

Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed.

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.datazone.*;
 CfnSubscriptionTarget cfnSubscriptionTarget = CfnSubscriptionTarget.Builder.create(this, "MyCfnSubscriptionTarget")
         .applicableAssetTypes(List.of("applicableAssetTypes"))
         .authorizedPrincipals(List.of("authorizedPrincipals"))
         .domainIdentifier("domainIdentifier")
         .environmentIdentifier("environmentIdentifier")
         .manageAccessRole("manageAccessRole")
         .name("name")
         .subscriptionTargetConfig(List.of(SubscriptionTargetFormProperty.builder()
                 .content("content")
                 .formName("formName")
                 .build()))
         .type("type")
         // the properties below are optional
         .provider("provider")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSubscriptionTarget.Builder	A fluent builder for CfnSubscriptionTarget.
static interface	CfnSubscriptionTarget.SubscriptionTargetFormProperty	The details of the subscription target configuration.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSubscriptionTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriptionTarget(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSubscriptionTarget(software.constructs.Construct scope, String id, CfnSubscriptionTargetProps props)

Method Summary

Modifier and Type	Method	Description
List<String>	getApplicableAssetTypes()	The asset types included in the subscription target.
String	getAttrCreatedAt()	The timestamp of when the subscription target was created.
String	getAttrCreatedBy()	The Amazon DataZone user who created the subscription target.
String	getAttrDomainId()	The identifier of the Amazon DataZone domain in which the subscription target exists.
String	getAttrEnvironmentId()	The identifier of the environment of the subscription target.
String	getAttrId()	The identifier of the subscription target.
String	getAttrProjectId()	The identifier of the project specified in the subscription target.
String	getAttrUpdatedAt()	The timestamp of when the subscription target was updated.
String	getAttrUpdatedBy()	The Amazon DataZone user who updated the subscription target.
List<String>	getAuthorizedPrincipals()	The authorized principals included in the subscription target.
protected Map<String,Object>	getCfnProperties()
String	getDomainIdentifier()	The ID of the Amazon DataZone domain in which subscription target is created.
String	getEnvironmentIdentifier()	The ID of the environment in which subscription target is created.
String	getManageAccessRole()	The manage access role that is used to create the subscription target.
String	getName()	The name of the subscription target.
String	getProvider()	The provider of the subscription target.
Object	getSubscriptionTargetConfig()	The configuration of the subscription target.
String	getType()	The type of the subscription target.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicableAssetTypes(List<String> value)	The asset types included in the subscription target.
void	setAuthorizedPrincipals(List<String> value)	The authorized principals included in the subscription target.
void	setDomainIdentifier(String value)	The ID of the Amazon DataZone domain in which subscription target is created.
void	setEnvironmentIdentifier(String value)	The ID of the environment in which subscription target is created.
void	setManageAccessRole(String value)	The manage access role that is used to create the subscription target.
void	setName(String value)	The name of the subscription target.
void	setProvider(String value)	The provider of the subscription target.
void	setSubscriptionTargetConfig(List<Object> value)	The configuration of the subscription target.
void	setSubscriptionTargetConfig(IResolvable value)	The configuration of the subscription target.
void	setType(String value)	The type of the subscription target.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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

CfnSubscriptionTarget

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

CfnSubscriptionTarget

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

CfnSubscriptionTarget

@Stability(Stable)
public CfnSubscriptionTarget(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSubscriptionTargetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp of when the subscription target was created.

getAttrCreatedBy

@Stability(Stable)
@NotNull
public String getAttrCreatedBy()

The Amazon DataZone user who created the subscription target.

getAttrDomainId

@Stability(Stable)
@NotNull
public String getAttrDomainId()

The identifier of the Amazon DataZone domain in which the subscription target exists.

getAttrEnvironmentId

@Stability(Stable)
@NotNull
public String getAttrEnvironmentId()

The identifier of the environment of the subscription target.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The identifier of the subscription target.

getAttrProjectId

@Stability(Stable)
@NotNull
public String getAttrProjectId()

The identifier of the project specified in the subscription target.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp of when the subscription target was updated.

getAttrUpdatedBy

@Stability(Stable)
@NotNull
public String getAttrUpdatedBy()

The Amazon DataZone user who updated the subscription target.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicableAssetTypes

@Stability(Stable)
@NotNull
public List<String> getApplicableAssetTypes()

The asset types included in the subscription target.

setApplicableAssetTypes

@Stability(Stable)
public void setApplicableAssetTypes(@NotNull
 List<String> value)

The asset types included in the subscription target.

getAuthorizedPrincipals

@Stability(Stable)
@NotNull
public List<String> getAuthorizedPrincipals()

The authorized principals included in the subscription target.

setAuthorizedPrincipals

@Stability(Stable)
public void setAuthorizedPrincipals(@NotNull
 List<String> value)

The authorized principals included in the subscription target.

getDomainIdentifier

@Stability(Stable)
@NotNull
public String getDomainIdentifier()

The ID of the Amazon DataZone domain in which subscription target is created.

setDomainIdentifier

@Stability(Stable)
public void setDomainIdentifier(@NotNull
 String value)

The ID of the Amazon DataZone domain in which subscription target is created.

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
public String getEnvironmentIdentifier()

The ID of the environment in which subscription target is created.

setEnvironmentIdentifier

@Stability(Stable)
public void setEnvironmentIdentifier(@NotNull
 String value)

The ID of the environment in which subscription target is created.

getManageAccessRole

@Stability(Stable)
@NotNull
public String getManageAccessRole()

The manage access role that is used to create the subscription target.

setManageAccessRole

@Stability(Stable)
public void setManageAccessRole(@NotNull
 String value)

The manage access role that is used to create the subscription target.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the subscription target.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the subscription target.

getSubscriptionTargetConfig

@Stability(Stable)
@NotNull
public Object getSubscriptionTargetConfig()

The configuration of the subscription target.

setSubscriptionTargetConfig

@Stability(Stable)
public void setSubscriptionTargetConfig(@NotNull
 IResolvable value)

The configuration of the subscription target.

setSubscriptionTargetConfig

@Stability(Stable)
public void setSubscriptionTargetConfig(@NotNull
 List<Object> value)

The configuration of the subscription target.

getType

@Stability(Stable)
@NotNull
public String getType()

The type of the subscription target.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of the subscription target.

getProvider

@Stability(Stable)
@Nullable
public String getProvider()

The provider of the subscription target.

setProvider

@Stability(Stable)
public void setProvider(@Nullable
 String value)

The provider of the subscription target.