Package software.amazon.awscdk.services.greengrass

Interface CfnSubscriptionDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriptionDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.619Z")
@Stability(Stable)
public interface CfnSubscriptionDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubscriptionDefinition.

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.greengrass.*;
 Object tags;
 CfnSubscriptionDefinitionProps cfnSubscriptionDefinitionProps = CfnSubscriptionDefinitionProps.builder()
         .name("name")
         // the properties below are optional
         .initialVersion(SubscriptionDefinitionVersionProperty.builder()
                 .subscriptions(List.of(SubscriptionProperty.builder()
                         .id("id")
                         .source("source")
                         .subject("subject")
                         .target("target")
                         .build()))
                 .build())
         .tags(tags)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubscriptionDefinitionProps.Builder	A builder for CfnSubscriptionDefinitionProps
static final class	CfnSubscriptionDefinitionProps.Jsii$Proxy	An implementation for CfnSubscriptionDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnSubscriptionDefinitionProps.Builder	builder()
default Object	getInitialVersion()	The subscription definition version to include when the subscription definition is created.
String	getName()	The name of the subscription definition.
default Object	getTags()	Application-specific metadata to attach to the subscription definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the subscription definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-name

getInitialVersion

@Stability(Stable)
@Nullable
default Object getInitialVersion()

The subscription definition version to include when the subscription definition is created.

A subscription definition version contains a list of subscription property types.

To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion resource and specify the ID of this subscription definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-initialversion

getTags

@Stability(Stable)
@Nullable
default Object getTags()

Application-specific metadata to attach to the subscription definition.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

 "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-subscriptiondefinition.html#cfn-greengrass-subscriptiondefinition-tags

builder

@Stability(Stable)
static CfnSubscriptionDefinitionProps.Builder builder()

Returns:

a CfnSubscriptionDefinitionProps.Builder of CfnSubscriptionDefinitionProps