metadata

Documentation

Index

• Constants
• type AutoNamingSpec
• type CfRefBehavior
• type CloudAPIFunction
• type CloudAPIMetadata
• type CloudAPIResource
• type CloudAPIType
• type NamingCondition
• type NamingPredicate
• type NamingRule
• type NamingTrivia
  • func (trivia *NamingTrivia) Length() int
• type NamingTriviaSpec
• type SemanticsSpec
• type SemanticsSpecDocument

Constants

const CfnCustomResourceToken = "aws-native:cloudformation:CustomResourceEmulator"

CfnCustomResourceToken is a Pulumi token for the resource to deploy CloudFormation custom resources.

const ExtensionResourceToken = "aws-native:index:ExtensionResource"

ExtensionResourceToken is a Pulumi token for the resource to deploy custom third-party CloudFormation types.

Types

type AutoNamingSpec

type AutoNamingSpec struct {
	SdkName    string            `json:"sdkName"`
	MinLength  int               `json:"minLength,omitempty"`
	MaxLength  int               `json:"maxLength,omitempty"`
	TriviaSpec *NamingTriviaSpec `json:"namingTriviaSpec,omitempty"`
}

type CfRefBehavior

type CfRefBehavior struct {
	// If set, indicates that Ref will return the value of the given Resource property directly.
	Property string `json:"property,omitempty"`

	// If set, indicates that Ref will return a string value obtained by joining several Resource properties with a
	// delimiter, typically "|".
	//
	// Usually these properties are strings, but they can also be objects, in which case their values are
	// JSON-encoded. See AWS::LakeFormation::PrincipalPermissions for an example of this.
	Properties []string `json:"properties,omitempty"`

	// Delimiter, typically "|". See [Properties].
	Delimiter string `json:"delimiter,omitempty"`

	// If set, Ref is not supported for this resource in CF.
	NotSupported bool `json:"notSupported,omitempty"`

	// If set, Ref is supported in CF but this metadata is not yet available in the Pulumi provider but might be
	// added in a later version.
	NotSupportedYet bool `json:"notSupportedYet,omitempty"`
}

Describes the behavior of CloudFormation Ref intrinsic for a given resource.

One and only one of [Property], [Properties], [NotSupported], [NotSupportedYet] must be set.

type CloudAPIFunction

type CloudAPIFunction struct {
	CfType      string   `json:"cf"`
	Identifiers []string `json:"ids"`
}

type CloudAPIMetadata

type CloudAPIMetadata struct {
	Resources map[string]CloudAPIResource `json:"resources"`
	Types     map[string]CloudAPIType     `json:"types"`
	Functions map[string]CloudAPIFunction `json:"functions"`
}

CloudAPIMetadata is a collection of all resources and types in the AWS Cloud Control API.

type CloudAPIResource

type CloudAPIResource struct {
	CfType            string                          `json:"cf"`
	Inputs            map[string]pschema.PropertySpec `json:"inputs"`
	Outputs           map[string]pschema.PropertySpec `json:"outputs"`
	AutoNamingSpec    *AutoNamingSpec                 `json:"autoNamingSpec,omitempty"`
	Required          []string                        `json:"required,omitempty"`
	CreateOnly        []string                        `json:"createOnly,omitempty"`
	WriteOnly         []string                        `json:"writeOnly,omitempty"`
	IrreversibleNames map[string]string               `json:"irreversibleNames,omitempty"`
	TagsProperty      string                          `json:"tagsProperty,omitempty"`
	TagsStyle         default_tags.TagsStyle          `json:"tagsStyle,omitempty"`

	// Describes the behavior of the CF Ref intrinsic for this resource.
	CfRef *CfRefBehavior `json:"cfRef,omitempty"`

	// PrimaryIdentifier is a list of Pulumi property names that together uniquely identify a resource.
	//
	// If more than one property is given, the values may be joined with the "|" character to form a specific
	// resource identifier value suitable for use with the Cloud Control API.
	//
	// See also https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html
	PrimaryIdentifier []string `json:"primaryIdentifier,omitempty"`
}

CloudAPIResource contains metadata for a single AWS Resource.

type CloudAPIType

type CloudAPIType struct {
	Type              string                          `json:"type"`
	Properties        map[string]pschema.PropertySpec `json:"properties,omitempty"`
	IrreversibleNames map[string]string               `json:"irreversibleNames,omitempty"`
}

CloudAPIType contains metadata for an auxiliary type.

type NamingCondition

type NamingCondition struct {
	Predicate NamingPredicate        `json:"predicate,omitempty"`
	Value     resource.PropertyValue `json:"value,omitempty"`
}

type NamingPredicate

type NamingPredicate string

const (
	NamingPredicateEquals             NamingPredicate = "equal"
	NamingPredicateNotEqual           NamingPredicate = "notEqual"
	NamingPredicateContains           NamingPredicate = "contains"
	NamingPredicateNotContains        NamingPredicate = "notContains"
	NamingPredicateStartsWith         NamingPredicate = "startsWith"
	NamingPredicateNotStartsWith      NamingPredicate = "notStartsWith"
	NamingPredicateEndsWith           NamingPredicate = "endsWith"
	NamingPredicateNotEndsWith        NamingPredicate = "notEndsWith"
	NamingPredicateLessThan           NamingPredicate = "lessThan"
	NamingPredicateLessThanOrEqual    NamingPredicate = "lessThanOrEqual"
	NamingPredicateGreaterThan        NamingPredicate = "greaterThan"
	NamingPredicateGreaterThanOrEqual NamingPredicate = "greaterThanOrEqual"
	NamingPredicateIn                 NamingPredicate = "in"
	NamingPredicateNotIn              NamingPredicate = "notIn"
	NamingPredicateExists             NamingPredicate = "exists"
	NamingPredicateNotExists          NamingPredicate = "notExists"
)

type NamingRule

type NamingRule struct {
	Field     resource.PropertyKey `json:"field,omitempty"`
	Condition *NamingCondition     `json:"condition,omitempty"`
}

type NamingTrivia

type NamingTrivia struct {
	Suffix string `json:"suffix,omitempty"`
}

NamingTrivia is a struct which contains any derived information about a resource's name that is used to generate a random name.

func (*NamingTrivia) Length

func (trivia *NamingTrivia) Length() int

type NamingTriviaSpec

type NamingTriviaSpec struct {
	Rule   *NamingRule   `json:"rule,omitempty"`
	Trivia *NamingTrivia `json:"trivia,omitempty"`
}

type SemanticsSpec

type SemanticsSpec struct {
	CfType           string                      `json:"cf,omitempty"`
	NamingTriviaSpec map[string]NamingTriviaSpec `json:"namingTriviaSpec,omitempty"`
}

type SemanticsSpecDocument

type SemanticsSpecDocument struct {
	Resources map[string]SemanticsSpec `json:"resources,omitempty"`
}