Skip to content

Latest commit

 

History

History
742 lines (742 loc) · 13.8 KB

cloudformationstack.md

File metadata and controls

742 lines (742 loc) · 13.8 KB
Raw

CloudFormationStack API reference

Packages:

cloudformation.contrib.fluxcd.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the CloudFormation v1alpha1 API group

Resource Types:

    CloudFormationStack

    CloudFormationStack is the Schema for the CloudFormation stack API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta     		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CloudFormationStackSpec

    stackName
    string

    Name of the CloudFormation stack. Note that if this value is changed after creation, the controller will NOT destroy the old stack and the old stack will no longer be updated by the controller.
    templatePath
    string     		(Optional)

    Path to the CloudFormation template file. Defaults to the root path of the SourceRef and filename ‘template.yaml’.
    sourceRef
    SourceReference

    SourceRef is the reference of the source where the CloudFormation template is stored.
    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the CloudFormation stack.
    pollInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to poll CloudFormation for the stack’s status while a stack action like Create or Update is in progress. Defaults to five seconds.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the CloudFormationStackSpec.Interval value to retry failures.
    stackParameters
    []StackParameter     		(Optional)

    The parameter keys and values to set on the stack
    stackTags
    []StackTag     		(Optional)

    The tag keys and values to set on the stack. Default tags will be added: cfn-flux-controller/version, cfn-flux-controller/name, cfn-flux-controller/namespace.
    suspend
    bool     		(Optional)

    Suspend tells the controller to suspend reconciliation for this CloudFormation stack, it does not apply to already started reconciliations. Defaults to false.
    destroyStackOnDeletion
    bool     		(Optional)

    Delete the CloudFormation stack and its underlying resources upon deletion of this object. Defaults to false.
    dependsOn
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference     		(Optional)

    DependsOn may contain a meta.NamespacedObjectReference slice with references to CloudFormationStack resources that must be ready before this CloudFormationStack can be reconciled.
    status
    CloudFormationStackStatus

    CloudFormationStackSpec

    (Appears on: CloudFormationStack)

    CloudFormationStackSpec defines the desired state of a CloudFormation stack

    Field Description
    stackName
    string

    Name of the CloudFormation stack. Note that if this value is changed after creation, the controller will NOT destroy the old stack and the old stack will no longer be updated by the controller.
    templatePath
    string     		(Optional)

    Path to the CloudFormation template file. Defaults to the root path of the SourceRef and filename ‘template.yaml’.
    sourceRef
    SourceReference

    SourceRef is the reference of the source where the CloudFormation template is stored.
    interval
    Kubernetes meta/v1.Duration

    The interval at which to reconcile the CloudFormation stack.
    pollInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to poll CloudFormation for the stack’s status while a stack action like Create or Update is in progress. Defaults to five seconds.
    retryInterval
    Kubernetes meta/v1.Duration     		(Optional)

    The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the CloudFormationStackSpec.Interval value to retry failures.
    stackParameters
    []StackParameter     		(Optional)

    The parameter keys and values to set on the stack
    stackTags
    []StackTag     		(Optional)

    The tag keys and values to set on the stack. Default tags will be added: cfn-flux-controller/version, cfn-flux-controller/name, cfn-flux-controller/namespace.
    suspend
    bool     		(Optional)

    Suspend tells the controller to suspend reconciliation for this CloudFormation stack, it does not apply to already started reconciliations. Defaults to false.
    destroyStackOnDeletion
    bool     		(Optional)

    Delete the CloudFormation stack and its underlying resources upon deletion of this object. Defaults to false.
    dependsOn
    []github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference     		(Optional)

    DependsOn may contain a meta.NamespacedObjectReference slice with references to CloudFormationStack resources that must be ready before this CloudFormationStack can be reconciled.

    CloudFormationStackStatus

    (Appears on: CloudFormationStack)

    CloudFormationStackStatus defines the observed state of a CloudFormation stack

    Field Description
    observedGeneration
    int64     		(Optional)

    ObservedGeneration is the last observed generation.
    ReconcileRequestStatus
    github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

    (Members of ReconcileRequestStatus are embedded into this type.)

    conditions
    []Kubernetes meta/v1.Condition     		(Optional)

    Conditions holds the conditions for the CloudFormationStack.
    lastAppliedRevision
    string     		(Optional)

    LastAppliedRevision is the revision of the last successfully applied source. The revision format for Git sources is @sha1:.
    lastAttemptedRevision
    string     		(Optional)

    LastAttemptedRevision is the revision of the last reconciliation attempt. The revision format for Git sources is @sha1:.
    lastAppliedChangeSet
    string     		(Optional)

    LastAppliedChangeSet is the ARN of the last successfully applied CloudFormation change set. The change set name format is flux--.
    lastAttemptedChangeSet
    string     		(Optional)

    LastAttemptedChangeSet is the ARN of the CloudFormation change set for the last reconciliation attempt. The change set name format is flux--.
    stackName
    string     		(Optional)

    StackName is the name of the CloudFormation stack created by the controller for the CloudFormationStack resource.

    ReadinessUpdate

    Field Description
    Reason
    string
    Message
    string
    SourceRevision
    string
    ChangeSetArn
    string

    SourceReference

    (Appears on: CloudFormationStackSpec)

    Reference to a Flux source object.

    Field Description
    apiVersion
    string     		(Optional)

    API version of the source object.
    kind
    string

    Kind of the source object.
    name
    string

    Name of the source object.
    namespace
    string     		(Optional)

    Namespace of the source object, defaults to the namespace of the CloudFormation stack object.

    StackParameter

    (Appears on: CloudFormationStackSpec)

    Key and value for a CloudFormation stack parameter.

    Field Description
    key
    string

    Name of the stack parameter in your CloudFormation template.
    value
    string

    Value of the stack parameter.

    StackTag

    (Appears on: CloudFormationStackSpec)

    Key and value for a CloudFormation stack tag.

    Field Description
    key
    string

    Name of the stack tag.
    value
    string

    Value of the stack tag.

    This page was automatically generated with gen-crd-api-reference-docs