META-INF.smithy.aws.cloudformation.smithy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-aws-cloudformation-traits Show documentation
This module provides Smithy traits and validators for CloudFormation.
There is a newer version: 1.54.0
Show newest version
$version: "2.0"

namespace aws.cloudformation

/// Indicates that the CloudFormation property generated from this member is an
/// additional identifier for the resource.
@unstable
@trait(
    selector: "structure > :test(member > string)",
    conflicts: [cfnExcludeProperty],
    breakingChanges: [{change: "remove"}]
)
structure cfnAdditionalIdentifier {}

/// The cloudFormationName trait allows a CloudFormation resource property name
/// to differ from a structure member name used in the model.
@unstable
@trait(
    selector: "structure > member",
    breakingChanges: [{change: "any"}]
)
string cfnName

/// Indicates that a structure member should not be included in generated
/// CloudFormation resource definitions.
@unstable
@trait(
    selector: "structure > member",
    conflicts: [
        cfnAdditionalIdentifier,
        cfnMutability,
        cfnDefaultValue
    ],
    breakingChanges: [{change: "add"}]
)
structure cfnExcludeProperty {}

/// Indicates that a structure member has a default value
/// for the property of the CloudFormation resource.
@unstable
@trait(
    selector: "resource > operation -[input, output]-> structure > member",
    conflicts: [cfnExcludeProperty]
)
structure cfnDefaultValue {}

/// Indicates an explicit CloudFormation mutability of the structure member
/// when part of a CloudFormation resource.
@unstable
@trait(
    selector: "structure > member",
    conflicts: [cfnExcludeProperty]
)
enum cfnMutability {
    /// Indicates that the CloudFormation property generated from this
    /// member does not have any mutability restrictions, meaning that it
    /// can be specified by the user and returned in a `read` or `list`
    /// request.
    FULL = "full"

    /// Indicates that the CloudFormation property generated from this
    /// member can be specified only during resource creation and can be
    /// returned in a `read` or `list` request.
    CREATE_AND_READ = "create-and-read"

    /// Indicates that the CloudFormation property generated from this
    /// member can be specified only during resource creation and cannot
    /// be returned in a `read` or `list` request. MUST NOT be set if the
    /// member is also marked with the `@additionalIdentifier` trait.
    CREATE = "create"


    /// Indicates that the CloudFormation property generated from this
    /// member can be returned by a `read` or `list` request, but
    /// cannot be set by the user.
    READ = "read"


    /// Indicates that the CloudFormation property generated from this
    /// member can be specified by the user, but cannot be returned by a
    /// `read` or `list` request. MUST NOT be set if the member is also
    /// marked with the `@additionalIdentifier` trait.
    WRITE = "write"
}

/// Indicates that a Smithy resource is a CloudFormation resource.
@unstable
@trait(
    selector: "resource",
    breakingChanges: [{change: "presence"}]
)
structure cfnResource {
    /// Provides a custom CloudFormation resource name.
    name: String,

    /// A list of additional shape IDs of structures that will have their
    /// properties added to the CloudFormation resource.
    additionalSchemas: StructureIdList,
}

@private
list StructureIdList {
    @idRef(failWhenMissing: true, selector: "structure")
    member: String
}