Documentation
¶
Index ¶
- func CfnRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRule_IsCfnElement(x interface{}) *bool
- func CfnRule_IsCfnResource(x interface{}) *bool
- func CfnRule_IsConstruct(x interface{}) *bool
- func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)
- type CfnRule
- type CfnRuleProps
- type CfnRule_ResourceTagProperty
- type CfnRule_RetentionPeriodProperty
- type CfnRule_UnlockDelayProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnRule_CFN_RESOURCE_TYPE_NAME ¶
func CfnRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnRule_IsCfnElement ¶
func CfnRule_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRule_IsCfnResource ¶
func CfnRule_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRule_IsConstruct ¶
func CfnRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnRule_Override ¶
func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)
Types ¶
type CfnRule ¶
type CfnRule interface {
awscdk.CfnResource
awscdk.IInspectable
awscdk.ITaggableV2
// Rule Arn is unique for each rule.
AttrArn() *string
// The unique ID of the retention rule.
AttrIdentifier() *string
// The lock state for the retention rule.
AttrLockState() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the retention rule.
Description() *string
SetDescription(val *string)
// Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
ExcludeResourceTags() interface{}
SetExcludeResourceTags(val interface{})
LockConfiguration() interface{}
SetLockConfiguration(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// Information about the resource tags used to identify resources that are retained by the retention rule.
ResourceTags() interface{}
SetResourceTags(val interface{})
// The resource type retained by the retention rule.
ResourceType() *string
SetResourceType(val *string)
// The retention period of the rule.
RetentionPeriod() interface{}
SetRetentionPeriod(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The state of the retention rule.
Status() *string
SetStatus(val *string)
// Information about the tags assigned to the retention rule.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Resource Type definition for AWS::Rbin::Rule.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRule := awscdk.Aws_rbin.NewCfnRule(this, jsii.String("MyCfnRule"), &CfnRuleProps{
ResourceType: jsii.String("resourceType"),
RetentionPeriod: &RetentionPeriodProperty{
RetentionPeriodUnit: jsii.String("retentionPeriodUnit"),
RetentionPeriodValue: jsii.Number(123),
},
// the properties below are optional
Description: jsii.String("description"),
ExcludeResourceTags: []interface{}{
&ResourceTagProperty{
ResourceTagKey: jsii.String("resourceTagKey"),
ResourceTagValue: jsii.String("resourceTagValue"),
},
},
LockConfiguration: &UnlockDelayProperty{
UnlockDelayUnit: jsii.String("unlockDelayUnit"),
UnlockDelayValue: jsii.Number(123),
},
ResourceTags: []interface{}{
&ResourceTagProperty{
ResourceTagKey: jsii.String("resourceTagKey"),
ResourceTagValue: jsii.String("resourceTagValue"),
},
},
Status: jsii.String("status"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html
func NewCfnRule ¶
func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule
type CfnRuleProps ¶
type CfnRuleProps struct {
// The resource type retained by the retention rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetype
//
ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"`
// The retention period of the rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-retentionperiod
//
RetentionPeriod interface{} `field:"required" json:"retentionPeriod" yaml:"retentionPeriod"`
// The description of the retention rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Information about the exclude resource tags used to identify resources that are excluded by the retention rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-excluderesourcetags
//
ExcludeResourceTags interface{} `field:"optional" json:"excludeResourceTags" yaml:"excludeResourceTags"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-lockconfiguration
//
LockConfiguration interface{} `field:"optional" json:"lockConfiguration" yaml:"lockConfiguration"`
// Information about the resource tags used to identify resources that are retained by the retention rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-resourcetags
//
ResourceTags interface{} `field:"optional" json:"resourceTags" yaml:"resourceTags"`
// The state of the retention rule.
//
// Only retention rules that are in the available state retain resources.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// Information about the tags assigned to the retention rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html#cfn-rbin-rule-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRule`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRuleProps := &CfnRuleProps{
ResourceType: jsii.String("resourceType"),
RetentionPeriod: &RetentionPeriodProperty{
RetentionPeriodUnit: jsii.String("retentionPeriodUnit"),
RetentionPeriodValue: jsii.Number(123),
},
// the properties below are optional
Description: jsii.String("description"),
ExcludeResourceTags: []interface{}{
&ResourceTagProperty{
ResourceTagKey: jsii.String("resourceTagKey"),
ResourceTagValue: jsii.String("resourceTagValue"),
},
},
LockConfiguration: &UnlockDelayProperty{
UnlockDelayUnit: jsii.String("unlockDelayUnit"),
UnlockDelayValue: jsii.Number(123),
},
ResourceTags: []interface{}{
&ResourceTagProperty{
ResourceTagKey: jsii.String("resourceTagKey"),
ResourceTagValue: jsii.String("resourceTagValue"),
},
},
Status: jsii.String("status"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rbin-rule.html
type CfnRule_ResourceTagProperty ¶
type CfnRule_ResourceTagProperty struct {
// The tag key of the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagkey
//
ResourceTagKey *string `field:"required" json:"resourceTagKey" yaml:"resourceTagKey"`
// The tag value of the resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-resourcetag.html#cfn-rbin-rule-resourcetag-resourcetagvalue
//
ResourceTagValue *string `field:"required" json:"resourceTagValue" yaml:"resourceTagValue"`
}
The resource tag of the rule.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
resourceTagProperty := &ResourceTagProperty{
ResourceTagKey: jsii.String("resourceTagKey"),
ResourceTagValue: jsii.String("resourceTagValue"),
}
type CfnRule_RetentionPeriodProperty ¶
type CfnRule_RetentionPeriodProperty struct {
// The retention period unit of the rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodunit
//
RetentionPeriodUnit *string `field:"required" json:"retentionPeriodUnit" yaml:"retentionPeriodUnit"`
// The retention period value of the rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodvalue
//
RetentionPeriodValue *float64 `field:"required" json:"retentionPeriodValue" yaml:"retentionPeriodValue"`
}
The retention period of the rule.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
retentionPeriodProperty := &RetentionPeriodProperty{
RetentionPeriodUnit: jsii.String("retentionPeriodUnit"),
RetentionPeriodValue: jsii.Number(123),
}
type CfnRule_UnlockDelayProperty ¶
type CfnRule_UnlockDelayProperty struct {
// The unit of time in which to measure the unlock delay.
//
// Currently, the unlock delay can be measure only in days.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html#cfn-rbin-rule-unlockdelay-unlockdelayunit
//
UnlockDelayUnit *string `field:"optional" json:"unlockDelayUnit" yaml:"unlockDelayUnit"`
// The unlock delay period, measured in the unit specified for UnlockDelayUnit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-unlockdelay.html#cfn-rbin-rule-unlockdelay-unlockdelayvalue
//
UnlockDelayValue *float64 `field:"optional" json:"unlockDelayValue" yaml:"unlockDelayValue"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
unlockDelayProperty := &UnlockDelayProperty{
UnlockDelayUnit: jsii.String("unlockDelayUnit"),
UnlockDelayValue: jsii.Number(123),
}