p6cdknamer

README

AWS CDK setups up a Custom Resource via Cloud Formation which sets the AWS IAM Account Alias

P6Namer

LICENSE

Other

Usage

...

import { P6Namer } from 'p6-cdk-namer';

new P6Namer(this, 'AccountAlias', {
  accountAlias: 'THE-ALIAS',
});

Architecture

Author

Philip M. Gollucci pgollucci@p6m7g8.com

Documentation

Overview

Sets the AWS IAM Account Alias with a Custom Resource

Index

• func NewP6Namer_Override(p P6Namer, scope constructs.Construct, id *string, props IP6NamerProps)
• func P6Namer_IsConstruct(x interface{}) *bool
• func P6Namer_IsResource(construct constructs.IConstruct) *bool
• type IP6NamerProps
• type P6Namer
  • func NewP6Namer(scope constructs.Construct, id *string, props IP6NamerProps) P6Namer

Functions

func NewP6Namer_Override

func NewP6Namer_Override(p P6Namer, scope constructs.Construct, id *string, props IP6NamerProps)

func P6Namer_IsConstruct

func P6Namer_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func P6Namer_IsResource

func P6Namer_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

Types

type IP6NamerProps

type IP6NamerProps interface {
	AccountAlias() *string
	SetAccountAlias(a *string)
}

type P6Namer

type P6Namer interface {
	awscdk.Resource
	// The environment this resource belongs to.
	//
	// For resources that are created and managed by the CDK
	// (generally, those created by creating new class instances like Role, Bucket, etc.),
	// this is always the same as the environment of the stack they belong to;
	// however, for imported resources
	// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
	// that might be different than the stack they were imported into.
	Env() *awscdk.ResourceEnvironment
	// The tree node.
	Node() constructs.Node
	// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by CloudFormation
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	PhysicalName() *string
	// The stack in which this resource is defined.
	Stack() awscdk.Stack
	// Apply the given removal policy to this resource.
	//
	// 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`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
	//
	// Normally, this token will resolve to `arnAttr`, but if the resource is
	// referenced across environments, `arnComponents` will be used to synthesize
	// a concrete ARN with the resource's physical name. Make sure to reference
	// `this.physicalName` in `arnComponents`.
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
	//
	// Normally, this token will resolve to `nameAttr`, but if the resource is
	// referenced across environments, it will be resolved to `this.physicalName`,
	// which will be a concrete name.
	GetResourceNameAttribute(nameAttr *string) *string
	// Returns a string representation of this construct.
	ToString() *string
}

func NewP6Namer

func NewP6Namer(scope constructs.Construct, id *string, props IP6NamerProps) P6Namer